[GRADLE-378] Gradle's javadoc task should provide more propreties that allow for finer-grained tuning of Javadoc Created: 29/Jan/09  Updated: 04/Jan/13  Resolved: 14/Mar/09

Status: Resolved
Project: Gradle
Affects Version/s: None
Fix Version/s: 0.6

Type: Bug
Reporter: Jon Cox Assignee: Tom Eyckmans
Resolution: Fixed Votes: 0

Attachments: Text File GRADLE-378-version2.patch    
Issue Links:
dependent
dependent by GRADLE-360 Let the Gradle javadoc task expose al... Resolved

 Description   

The current level of tuning offered by Gradle's javadoc task is inadequate.
While it would be nice if every feature were supported, most users expect
the most commonly used features of Javadoc to be available.

Some properties are inherently problematic, like "private" (which is a Groovy keyword),
and some require more back & forth between the underlying Ant.javadoc object than
is convenient w/o the use of properties devoted to passing closures (which might be cool
but might also represent a bit of work to get the interface just right). Still there's a lot of
"low hanging fruit" – commonly needed stuff that's easy to implement.

 Comments   
Comment by Jon Cox [ 29/Jan/09 ]

This somewhat clumsily-written patch makes Gradle's javadoc task
support the following options:

  • access
  • author
  • encoding
  • excludes
  • footer
  • header
  • helpFile
  • includes
  • locale
  • maxMemory
  • overview
  • splitIndex
  • stylesheetFile
  • title
  • use
  • verbose
  • version

Also included in this patch is an update to the TeX-based userguide.
All the new options are documented, and the tables & page breaks
seem to be in the right places. Aside: TeX output can be pretty,
but what a pain!

There are a few shortcomings to this patch:

  • I followed the pattern already present, rather than using an 'options' object
    This means I've got a 20-arg function call to handle all the params. Ugly.
  • A few other options should be supported, but aren't (like the ability to set a custom doclet).
  • My hand testing was pretty light (things did seem to work though).
  • There are no automated tests yet – sorry.

That said, I think this covers the bulk of my own javadoc needs,
and hopefully those of others too. Also, I fixed the pre-existing
javadoc tests so they don't barf. If you like this patch I'll try to
figure out how to write a test in groovy.... or I'll just do it in java.

After speaking with Hans, I'm guessing that Java-based tests
are probably the best bet (most of the time).

Comment by Jon Cox [ 30/Jan/09 ]

I just took down the prior version of this patch, and am posting
an updated one (GRADLE-378-version2.patch) that covers the
following javadoc config. properties:

  • access
  • additionalParam
  • author
  • breakIterator
  • classPath
  • defaultExcludes
  • doclet
  • docletPath
  • encoding
  • footer
  • group
  • header
  • helpFile
  • link
  • linkOffline
  • linkSource
  • locale
  • maxMemory
  • overview
  • splitIndex
  • stylesheetFile
  • title
  • use
  • useExternalFile
  • verbose
  • version
Comment by Tom Eyckmans [ 23/Feb/09 ]

I've worked my way through the reference documenation and added all the core javadoc options and the options of the standard doclet.

This is done in a class hierarchy that can be extended in you want to use a different doclet you can plug in your own options class for the options of the doclet you are using.

If you urgently need this functionality you can get it from http://github.com/teyckmans/gradle/commits/javadoc note that this is still dev code and some more testing needs to be done in order to make sure everything is in order.

Comment by Tom Eyckmans [ 14/Mar/09 ]

all options the core Javadoc options and all the options of the standard doclet are now available in trunk

Generated at Wed Jun 30 11:28:37 CDT 2021 using Jira 8.4.2#804003-sha1:d21414fc212e3af190e92c2d2ac41299b89402cf.