lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Otis Gospodnetic <otis_gospodne...@yahoo.com>
Subject Re: internal documentation
Date Thu, 19 Sep 2002 18:50:29 GMT
Yummy, thanks, I've been craving for something like this.
OpenOffice works for me.


--- Doug Cutting <cutting@lucene.com> wrote:
> Otis Gospodnetic wrote:
>  > --- Doug Cutting <cutting@lucene.com> wrote:
>  >>Maybe we should add another target: javadocs-internal or
> something.
>  >>That would be good encouragement to add javadoc comments to
> internal
>  >>classes.
>  >
> > Sounds good to me.
> > I think it would encourage documentation of internals (not really
> > existent now) and help those who want to improve internals, develop
> > additional core code, or at least understand the existing code.
> 
> I recently wrote some Lucene internal documentation for another
> project 
> I'm working on.  It describes the binary format of Lucene's indexes. 
> This is a reference document: it doesn't try to explain why
> particular 
> file structures are used, but rather only tries to precisely define 
> those that are used.
> 
> I've attached this in Open Office format and as HTML.  The HTML 
> conversion is not great, but it's readable.  Perhaps I should
> maintain 
> this in HTML instead of Open Office, since it contains no diagrams...
> 
> Doug
> 

> ATTACHMENT part 2 application/vnd.sun.xml.writer name=FileFormats.sxw
> --
> To unsubscribe, e-mail:  
> <mailto:lucene-dev-unsubscribe@jakarta.apache.org>
> For additional commands, e-mail:
<mailto:lucene-dev-help@jakarta.apache.org>


__________________________________________________
Do you Yahoo!?
New DSL Internet Access from SBC & Yahoo!
http://sbc.yahoo.com

--
To unsubscribe, e-mail:   <mailto:lucene-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:lucene-dev-help@jakarta.apache.org>


Mime
View raw message