lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Paul Elschot <paul.elsc...@xs4all.nl>
Subject Re: 2.4.0 missing javadocs
Date Fri, 13 Feb 2009 07:44:20 GMT
On Friday 13 February 2009 02:14:21 Michael McCandless wrote:
> 
> An Hong wrote:
> 
> > Hi,
> > I wonder how come the API javadoc at http://lucene.apache.org/java/2_4_0/api/core/index.html

> >  is missing entries for classes like
> > org.apache.lucene.index.DocumentsWriter, DocumentsWriterThreadState  
> > and many others.
> 
> That's because they're package private.

One can add the access="private" attribute to javadoc tasks in the build.xml file.
Other possible values are package, protected and public.

There used to be a javadocs-internal target with private access, but it was
removed when the javadocs building targets were extended some time ago:
https://issues.apache.org/jira/browse/LUCENE-376

Regards,
Paul Elschot


> 
> > Doing “ant javadocs” locally does not generate the javadoc for these  
> > classes either, and I’m seeing errors such as,
> >
> >   [javadoc] javadoc: error - Error while reading file C:\svn 
> > \lucenestuff\lucene-2.4.0\contrib\ant\src\java\overview.html
> 
> Not sure about that one.
> 
> >   [javadoc] Generating C:\svn\lucenestuff\lucene-2.4.0\build\docs\api 
> > \contrib-ant\stylesheet.css...
> >   [javadoc] Note: Custom tags that could override future standard  
> > tags:  @todo. To avoid potential overrides, use at least one period  
> > character (.) in custom tag names.
> >   [javadoc] Note: Custom tags that were not seen:  @uml.property
> 
> @todo and @uml.property  custom tags declared in common-build.xml.
> 
> Mike
> ---------------------------------------------------------------------
> 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