Mailing-List: contact java-dev-help@lucene.apache.org; run by ezmlm
Precedence: bulk
Reply-To: java-dev@lucene.apache.org
Message-ID: <31796316.1195017763285.JavaMail.jira@brutus>
Date: Tue, 13 Nov 2007 21:22:43 -0800 (PST)
From: "Michael Busch (JIRA)" <jira@apache.org>
To: java-dev@lucene.apache.org
Subject: [jira] Commented: (LUCENE-1051) Separate javadocs for core and
 contribs
In-Reply-To: <15361587.1194830090798.JavaMail.jira@brutus>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit


    [ https://issues.apache.org/jira/browse/LUCENE-1051?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12542322 ] 

Michael Busch commented on LUCENE-1051:
---------------------------------------

I'm planning to commit this tomorrow... any objections? Did anyone look at the preview yet?

> Separate javadocs for core and contribs
> ---------------------------------------
>
>                 Key: LUCENE-1051
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1051
>             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:
> http://people.apache.org/~buschmi/site-preview/index.html
> 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: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org