lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Paul Elschot (JIRA)" <>
Subject [jira] Commented: (LUCENE-1051) Separate javadocs for core and contribs
Date Wed, 14 Nov 2007 07:41:43 GMT


Paul Elschot commented on LUCENE-1051:

This has been somewhere far down on my todo list for quite a while, so I was going to try
the patch, but a committed version would certainly be easier. In case you prefer someone else
to try this before committing, could you wait a (short) week?

> Separate javadocs for core and contribs
> ---------------------------------------
>                 Key: LUCENE-1051
>                 URL:
>             Project: Lucene - Java
>          Issue Type: Improvement
>          Components: Javadocs
>            Reporter: Michael Busch
>            Assignee: Michael Busch
>            Priority: Minor
>             Fix For: 2.3
>         Attachments: lucene-1051-take2.patch, lucene-1051.patch
> A while ago we had a discussion on java-dev about separating the javadocs
> for the contrib modules instead of having only one big javadoc containing 
> the core and contrib classes.
> This patch:
> * Adds new targets to build.xml: 
>   ** "javadocs-all" Generates Javadocs for the core, demo, and contrib 
>     classes
>   ** "javadocs-core" Generates Javadocs for the core classes
>   ** "javadocs-demo" Generates Javadocs for the demo classes
>   ** "javadocs-contrib" Using contrib-crawl it generates the Javadocs for 
>     all contrib modules, except "similarity" (currently empty) and gdata.
> * Adds submenues to the Javadocs link on the Lucene site with links to
>   the different javadocs
> * Includes the javadocs in the maven artifacts
> Remarks:
> - I removed the ant target "javadocs-internal", because I didn't want to
>   add corresponding targets for all new javadocs target. Instead I 
>   defined a new property "javadoc.access", so now  
>   "ant -Djavadoc.access=package" can be used in combination with any of
>   the javadocs targets. Is this ok?
> - I didn't include gdata (yet) because it uses build files that don't 
>   extend Lucenes standard build files.
> Here's a preview:
> Please let me know what you think about these changes!

This message is automatically generated by JIRA.
You can reply to this email to add a comment to the issue online.

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message