You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Grant Ingersoll (JIRA)" <ji...@apache.org> on 2007/01/04 02:46:27 UTC
[jira] Created: (LUCENE-765) Index package level javadocs needs
content
Index package level javadocs needs content
------------------------------------------
Key: LUCENE-765
URL: https://issues.apache.org/jira/browse/LUCENE-765
Project: Lucene - Java
Issue Type: Task
Components: Javadocs
Reporter: Grant Ingersoll
Priority: Minor
The org.apache.lucene.index package level javadocs are sorely lacking. They should be updated to give a summary of the important classes, how indexing works, etc. Maybe give an overview of how the different writers coordinate. Links to file formats, information on the posting algorithm, etc. would be helpful.
See the search package javadocs as a sample of the kind of info that could go here.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org
[jira] Updated: (LUCENE-765) Index package level javadocs needs
content
Posted by "Michael Busch (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-765?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Michael Busch updated LUCENE-765:
---------------------------------
Fix Version/s: 2.2
Issue Type: Wish (was: Task)
> Index package level javadocs needs content
> ------------------------------------------
>
> Key: LUCENE-765
> URL: https://issues.apache.org/jira/browse/LUCENE-765
> Project: Lucene - Java
> Issue Type: Wish
> Components: Javadocs
> Reporter: Grant Ingersoll
> Priority: Minor
> Fix For: 2.2
>
>
> The org.apache.lucene.index package level javadocs are sorely lacking. They should be updated to give a summary of the important classes, how indexing works, etc. Maybe give an overview of how the different writers coordinate. Links to file formats, information on the posting algorithm, etc. would be helpful.
> See the search package javadocs as a sample of the kind of info that could go here.
--
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
[jira] Commented: (LUCENE-765) Index package level javadocs needs
content
Posted by "Daniel Naber (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-765?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12462203 ]
Daniel Naber commented on LUCENE-765:
-------------------------------------
Some of this is already here:
http://lucene.apache.org/java/docs/api/overview-summary.html#overview_description
> Index package level javadocs needs content
> ------------------------------------------
>
> Key: LUCENE-765
> URL: https://issues.apache.org/jira/browse/LUCENE-765
> Project: Lucene - Java
> Issue Type: Task
> Components: Javadocs
> Reporter: Grant Ingersoll
> Priority: Minor
>
> The org.apache.lucene.index package level javadocs are sorely lacking. They should be updated to give a summary of the important classes, how indexing works, etc. Maybe give an overview of how the different writers coordinate. Links to file formats, information on the posting algorithm, etc. would be helpful.
> See the search package javadocs as a sample of the kind of info that could go here.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org
[jira] Updated: (LUCENE-765) Index package level javadocs needs
content
Posted by "Michael Busch (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-765?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Michael Busch updated LUCENE-765:
---------------------------------
Fix Version/s: (was: 2.2)
> Index package level javadocs needs content
> ------------------------------------------
>
> Key: LUCENE-765
> URL: https://issues.apache.org/jira/browse/LUCENE-765
> Project: Lucene - Java
> Issue Type: Wish
> Components: Javadocs
> Reporter: Grant Ingersoll
> Priority: Minor
>
> The org.apache.lucene.index package level javadocs are sorely lacking. They should be updated to give a summary of the important classes, how indexing works, etc. Maybe give an overview of how the different writers coordinate. Links to file formats, information on the posting algorithm, etc. would be helpful.
> See the search package javadocs as a sample of the kind of info that could go here.
--
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