You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by Doug Cutting <cu...@lucene.com> on 2002/09/19 19:49:03 UTC
internal documentation
Otis Gospodnetic wrote:
> --- Doug Cutting <cu...@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
Internal Documentation and Field Sorting
Posted by Peter Carlson <ca...@bookandhammer.com>.
Doug,
This is really great. It provides clarity into the architecture of
Lucene that I didn't have before.
Thanks.
--Peter
On Thursday, September 19, 2002, at 10:56 AM, Doug Cutting wrote:
> Doug Cutting wrote:
>> For some reason the HTML conversion was dropped in the copy I
>> received.
>> So here it is again.
>
> Looks like this mailing list drops HTML attachments...
>
> This time I zipped it. We'll see if that works.
>
> Doug
> <FileFormats.zip>--
> To unsubscribe, e-mail:
> <ma...@jakarta.apache.org>
> For additional commands, e-mail:
> <ma...@jakarta.apache.org>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: internal documentation
Posted by Doug Cutting <cu...@lucene.com>.
Doug Cutting wrote:
> For some reason the HTML conversion was dropped in the copy I received.
>
> So here it is again.
Looks like this mailing list drops HTML attachments...
This time I zipped it. We'll see if that works.
Doug
Re: internal documentation
Posted by Doug Cutting <cu...@lucene.com>.
Doug Cutting wrote:
> 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...
For some reason the HTML conversion was dropped in the copy I received.
So here it is again.
Doug
Re: internal documentation
Posted by Eugene Gluzberg <dr...@apache.org>.
Kinda late reply, but can we put this into cvs??
Otis Gospodnetic wrote:
> Yummy, thanks, I've been craving for something like this.
> OpenOffice works for me.
>
>
> --- Doug Cutting <cu...@lucene.com> wrote:
>
>>Otis Gospodnetic wrote:
>> > --- Doug Cutting <cu...@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:
>><ma...@jakarta.apache.org>
>>For additional commands, e-mail:
>
> <ma...@jakarta.apache.org>
>
>
> __________________________________________________
> Do you Yahoo!?
> New DSL Internet Access from SBC & Yahoo!
> http://sbc.yahoo.com
>
> --
> To unsubscribe, e-mail: <ma...@jakarta.apache.org>
> For additional commands, e-mail: <ma...@jakarta.apache.org>
>
>
>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: internal documentation
Posted by Otis Gospodnetic <ot...@yahoo.com>.
Yummy, thanks, I've been craving for something like this.
OpenOffice works for me.
--- Doug Cutting <cu...@lucene.com> wrote:
> Otis Gospodnetic wrote:
> > --- Doug Cutting <cu...@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:
> <ma...@jakarta.apache.org>
> For additional commands, e-mail:
<ma...@jakarta.apache.org>
__________________________________________________
Do you Yahoo!?
New DSL Internet Access from SBC & Yahoo!
http://sbc.yahoo.com
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>