[
https://issues.apache.org/jira/browse/SOLR-3904?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13465842#comment-13465842
]
Robert Muir commented on SOLR-3904:
-----------------------------------
Current output of 'documentation-lint' with the patch:
{noformat}
[exec]
/home/rmuir/workspace/lucene-trunk/solr/build/docs/solr-velocity/overview-summary.html
[exec] missing: org.apache.solr.response
[exec]
[exec]
/home/rmuir/workspace/lucene-trunk/solr/build/docs/solr-core/overview-summary.html
[exec] missing: org.apache.solr
[exec] missing: org.apache.solr.analysis
[exec] missing: org.apache.solr.client.solrj.embedded
[exec] missing: org.apache.solr.cloud
[exec] missing: org.apache.solr.common
[exec] missing: org.apache.solr.core
[exec] missing: org.apache.solr.handler
[exec] missing: org.apache.solr.handler.admin
[exec] missing: org.apache.solr.handler.component
[exec] missing: org.apache.solr.handler.loader
[exec] missing: org.apache.solr.highlight
[exec] missing: org.apache.solr.internal.csv
[exec] missing: org.apache.solr.internal.csv.writer
[exec] missing: org.apache.solr.logging
[exec] missing: org.apache.solr.logging.jul
[exec] missing: org.apache.solr.request
[exec] missing: org.apache.solr.response
[exec] missing: org.apache.solr.response.transform
[exec] missing: org.apache.solr.schema
[exec] missing: org.apache.solr.search
[exec] missing: org.apache.solr.search.function
[exec] missing: org.apache.solr.search.function.distance
[exec] missing: org.apache.solr.search.grouping
[exec] missing: org.apache.solr.search.grouping.collector
[exec] missing: org.apache.solr.search.grouping.distributed
[exec] missing: org.apache.solr.search.grouping.distributed.command
[exec] missing:
org.apache.solr.search.grouping.distributed.requestfactory
[exec] missing:
org.apache.solr.search.grouping.distributed.responseprocessor
[exec] missing:
org.apache.solr.search.grouping.distributed.shardresultserializer
[exec] missing: org.apache.solr.search.grouping.endresulttransformer
[exec] missing: org.apache.solr.search.similarities
[exec] missing: org.apache.solr.servlet
[exec] missing: org.apache.solr.servlet.cache
[exec] missing: org.apache.solr.spelling
[exec] missing: org.apache.solr.spelling.suggest
[exec] missing: org.apache.solr.spelling.suggest.fst
[exec] missing: org.apache.solr.spelling.suggest.jaspell
[exec] missing: org.apache.solr.spelling.suggest.tst
[exec] missing: org.apache.solr.update
[exec] missing: org.apache.solr.update.processor
[exec] missing: org.apache.solr.util
[exec] missing: org.apache.solr.util.plugin
[exec] missing: org.apache.solr.util.xslt
[exec]
[exec]
/home/rmuir/workspace/lucene-trunk/solr/build/docs/solr-analysis-extras/overview-summary.html
[exec] missing: org.apache.solr.schema
[exec]
[exec]
/home/rmuir/workspace/lucene-trunk/solr/build/docs/solr-clustering/overview-summary.html
[exec] missing: org.apache.solr.handler.clustering
[exec] missing: org.apache.solr.handler.clustering.carrot2
[exec]
[exec]
/home/rmuir/workspace/lucene-trunk/solr/build/docs/solr-langid/overview-summary.html
[exec] missing: org.apache.solr.update.processor
[exec]
[exec]
/home/rmuir/workspace/lucene-trunk/solr/build/docs/solr-solrj/overview-summary.html
[exec] missing: org.apache.noggit
[exec] missing: org.apache.solr.client.solrj
[exec] missing: org.apache.solr.client.solrj.beans
[exec] missing: org.apache.solr.client.solrj.impl
[exec] missing: org.apache.solr.client.solrj.request
[exec] missing: org.apache.solr.client.solrj.response
[exec] missing: org.apache.solr.client.solrj.util
[exec] missing: org.apache.solr.common
[exec] missing: org.apache.solr.common.cloud
[exec] missing: org.apache.solr.common.luke
[exec] missing: org.apache.solr.common.params
[exec] missing: org.apache.solr.common.util
[exec]
[exec]
/home/rmuir/workspace/lucene-trunk/solr/build/docs/solr-uima/overview-summary.html
[exec] missing: org.apache.solr.uima.processor
[exec]
[exec]
/home/rmuir/workspace/lucene-trunk/solr/build/docs/solr-dataimporthandler/overview-summary.html
[exec] missing: org.apache.solr.handler.dataimport
[exec] missing: org.apache.solr.handler.dataimport.config
[exec]
[exec]
/home/rmuir/workspace/lucene-trunk/solr/build/docs/solr-cell/overview-summary.html
[exec] missing: org.apache.solr.handler.extraction
[exec]
[exec]
/home/rmuir/workspace/lucene-trunk/solr/build/docs/solr-test-framework/overview-summary.html
[exec] missing: org.apache.solr
[exec] missing: org.apache.solr.analysis
[exec] missing: org.apache.solr.cloud
[exec] missing: org.apache.solr.core
[exec] missing: org.apache.solr.update.processor
[exec] missing: org.apache.solr.util
[exec]
[exec]
/home/rmuir/workspace/lucene-trunk/solr/build/docs/solr-dataimporthandler-extras/overview-summary.html
[exec] missing: org.apache.solr.handler.dataimport
[exec]
[exec] Missing javadocs were found!
BUILD FAILED
{noformat}
> add package level javadocs to every package
> -------------------------------------------
>
> Key: SOLR-3904
> URL: https://issues.apache.org/jira/browse/SOLR-3904
> Project: Solr
> Issue Type: Improvement
> Components: documentation
> Reporter: Hoss Man
> Assignee: Hoss Man
> Fix For: 4.1
>
> Attachments: SOLR-3904_buildxml.patch
>
>
> quoth rmuir on the mailing list...
> {quote}
> We've been working on this for the lucene side (3.6 was the first
> release where every package had docs, 4.0 will be the first where
> every class had docs, and we are now working towards
> methods/fields/ctors/enums).
> I think this would be valuable for solr too (especially solrj as a start).
> Besides users, its really useful to developers as well. Of course we
> all think our code is self-documenting, but its not always the case. a
> few extra seconds can save someone a ton of time trying to figure out
> your code.
> Additionally at least in my IDE, when things are done as javadoc
> comments then they are more easily accessible than code comments. I'm
> sure its the case for some other development environments too.
> Filling in these package.html's to at least have a one sentence
> description would be a really good start. It lets someone know where
> to go at the high-level.
> If I was brand new to solr and wanted to write a java app that uses
> solrj, i wouldn't have a clue where to start
> (https://builds.apache.org/job/Solr-Artifacts-4.x/javadoc/solr-solrj/index.html).
> 12 sentences could go a really long way.
> And for all new code, I hope we can all try harder for more complete
> javadocs. when you are working on something and its fresh in your head
> its a lot easier to do this than for someone else to come back around
> and figure it out.
> {quote}
> I'm going to try and make it a priority for me to fill in package level docs
> as we look towards 4.1
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
