lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Grant Ingersoll <gsing...@apache.org>
Subject Re: Documentation Brainstorming
Date Thu, 31 May 2007 20:24:08 GMT
I like the suggestion of having two views: a unified view and then  
also a separate view.  Slightly more work to setup, but should  
satisfy both camps.

On May 31, 2007, at 1:16 PM, Doug Cutting wrote:

>
> I like the single javadoc build.  The linking is nice, e.g., all  
> Analyzer implementations are linked from Analyzer.  It also makes  
> it easier for folks to see everything that's included in the  
> release in one place.

True

>
> Perhaps the names of the sections should be the name of the jar  
> file, and/or the summary sentence in the package.html for contrib  
> packages should name the jar file.  Would that suffice?
>

I find the lower left frame to be the main pain for me, since it  
isn't clear there what is in core and what is in contrib.

> However if most folks really wish to split things, then some new  
> navigational pages are required to provide a home for the various  
> javadocs.  Ideally this would provide the level of integration  
> that, e.g., Ant's optional tasks have with Ant's core tasks: when  
> browsing core tasks there's always a link to optional tasks, and  
> vice-versa, so the optional stuff is always just a single click  
> away.  Putting contrib and core javadoc together achieves this.   
> Achieving it with separate javadocs will be harder.
>

Makes sense.

---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


Mime
View raw message