Footer in Scaladoc

On Thu, Sep 1, 2011 at 8:32 PM, Indrajit Raychaudhuri <indrajitr@gmail.com> wrote:

Folks,

Scaladoc generates a footer now [1].

That's cool, however wondering if it could be provided as an option to scaladoc instead (say as `-doc-footer`). In that case, other libraries would have flexibility to change/modify as they deem fit.

Good point, yes. -- Martin

Hi Indrajit,
Good point. Just added that functionality. 
So now, when generating scaladoc, by default, no footer is shown. If you'd like to add your own footer, you can pass it as a command line option (i.e., scaladoc -doc-footer "Copyright (c) 100BC-2011 Foobar, LLC.")
Cheers, Heather

On Sep 1, 2011, at 12:41 PM, martin odersky wrote:

On Thu, Sep 1, 2011 at 8:32 PM, Indrajit Raychaudhuri <indrajitr@gmail.com> wrote:

Folks,

Scaladoc generates a footer now [1].

That's cool, however wondering if it could be provided as an option to scaladoc instead (say as `-doc-footer`). In that case, other libraries would have flexibility to change/modify as they deem fit.

Good point, yes. -- Martin

Hi Heather,

This is barely an issue for me at all, but wouldn't this be more appropriate as an annotation in a Scaladoc comment on the package object? It seems a bit wrong to be defining content in the build rather than the code (or to be able to "claim" copyright be regenerating with different parameters), and I wouldn't want defining more and more similar pieces of content to become more parameters to the CLI invocation.

Cheers,
Jon

Hi,

> This is barely an issue for me at all, but wouldn't this be more appropriate
> as an annotation in a Scaladoc comment on the package object? It seems a bit
> wrong to be defining content in the build rather than the code (or to be
> able to "claim" copyright be regenerating with different parameters), and I
> wouldn't want defining more and more similar pieces of content to become
> more parameters to the CLI invocation.

good idea!

I wonder if there is a way to integrate this with the copyright
headers which most companies/projects already use.

Thanks and bye,

Simon

Hi
One problem I could see with using the copyright headers as the footer is that I use the footer (in java projects) to include project build version and/or build date etc, and this would be ruled out.   
Javadoc as the concept of 'argument file' (http://bit.ly/o8f2mk) where all parameters are in a file and the file used ( ie javadoc @argfile ) Would keeping the parameter but introducing this, maybe at a latter date, be a better solution.
andy

Hi,

Javadoc as the concept of 'argument file' (http://bit.ly/o8f2mk) where all parameters are in a file and the file used ( ie javadoc @argfile ) Would keeping the parameter but introducing this, maybe at a latter date, be a better solution.

actually, I exactly need this, too. I have made some patches which enable ScalaDoc to link to external documentation sources and this needs some config file, because I don't want make every Scala developer recompile the Scala compiler to add another package/URL pair.

Thanks and bye,

Simon

Thanks Heather for the functionality!

AFAIK, scalac has the @file option. And since all scalac options are available with scaladoc, @file option should be available there as well. At least that what `scalac -help` and `scaldoc -help` claims :)

Simon, you might be aware that vscaladoc (by DavidB) used to have this nice facility of providing a property file where external doc URL could be saved (key being the package name and value being the doc url). You might want to take a look at that in case it's of relevance :)

- Indrajit

On Wednesday 7 September 2011 at 10:03 PM, Simon Ochsenreither wrote:

> Hi,
> >
> > Javadoc as the concept of 'argument file' (http://bit.ly/o8f2mk) where all parameters are in a file and the file used ( ie javadoc @argfile ) Would keeping the parameter but introducing this, maybe at a latter date, be a better solution.
> actually, I exactly need this, too. I have made some patches which enable ScalaDoc to link to external documentation sources and this needs some config file, because I don't want make every Scala developer recompile the Scala compiler to add another package/URL pair.
>
> Thanks and bye,
>
> Simon

Hi
scaladoc does have a @file option as I've just tried it. Earlier I was just reading the man page (scala-2.9.1.final-devel-docs/tools/scaladoc.html) and that does not mention the option. (always good to learn something new )
andy