public classes with no javadocs
-------------------------------
Key: LUCENE-3902
URL: https://issues.apache.org/jira/browse/LUCENE-3902
Project: Lucene - Java
Issue Type: Improvement
Components: general/javadocs
Reporter: Robert Muir
Here is a list of public classes with no javadocs.
I think even some simple javadocs can be valuable for all javadocs classes:
* in various summaries, we don't see an empty summary for what the class does
* easier to work with the source in various IDEs that present this stuff on
hover, etc
* better documentation for developers to know what all these classes do.
Maybe we don't have time to fix this for 3.x, but it would be great if anybody
has good knowledge of these classes and could commit any useful stuff to the
javadocs.
Here is the list from Mike's tool on LUCENE-3887
{noformat}
rmuir@beast:~/workspace/lucene-branch3x2/dev-tools/scripts$ python
checkJavaDocs.py ../../lucene/build/docs/api
Check...
../../lucene/build/docs/api/all/org/tartarus/snowball/package-summary.html
missing: Among
missing: TestApp
../../lucene/build/docs/api/all/org/apache/lucene/spatial/tier/package-summary.html
missing: DistanceHandler.Precision
../../lucene/build/docs/api/all/org/apache/lucene/index/package-summary.html
missing: MergePolicy.MergeAbortedException
../../lucene/build/docs/api/all/org/apache/lucene/index/pruning/package-summary.html
missing: CarmelTopKTermPruningPolicy.ByDocComparator
missing: CarmelUniformTermPruningPolicy.ByDocComparator
../../lucene/build/docs/api/all/org/apache/lucene/util/package-summary.html
missing: ByteBlockPool.Allocator
missing: ByteBlockPool.DirectAllocator
missing: ByteBlockPool.DirectTrackingAllocator
missing: BytesRefHash.BytesStartArray
missing: BytesRefHash.DirectBytesStartArray
missing: BytesRefIterator.EmptyBytesRefIterator
missing: DoubleBarrelLRUCache.CloneableKey
missing: English
missing: OpenBitSetDISI
missing: PagedBytes.Reader
missing: StoreClassNameRule
missing: SystemPropertiesInvariantRule
missing: UncaughtExceptionsRule.UncaughtExceptionEntry
missing: UnicodeUtil.UTF16Result
missing: UnicodeUtil.UTF8Result
../../lucene/build/docs/api/all/org/apache/lucene/queryParser/core/nodes/package-summary.html
missing: TextableQueryNode
missing: PathQueryNode.QueryText
missing: PhraseSlopQueryNode
missing: ProximityQueryNode.ProximityType
missing: ModifierQueryNode.Modifier
missing: ParametricQueryNode.CompareOperator
missing: ProximityQueryNode.Type
../../lucene/build/docs/api/all/org/apache/lucene/queryParser/core/parser/package-summary.html
missing: EscapeQuerySyntax.Type
../../lucene/build/docs/api/all/org/apache/lucene/queryParser/standard/builders/package-summary.html
missing: AnyQueryNodeBuilder
../../lucene/build/docs/api/all/org/apache/lucene/queryParser/standard/config/package-summary.html
missing: FuzzyConfig
missing: StandardQueryConfigHandler.ConfigurationKeys
missing: DefaultOperatorAttribute.Operator
missing: StandardQueryConfigHandler.Operator
../../lucene/build/docs/api/all/org/apache/lucene/queryParser/standard/parser/package-summary.html
missing: EscapeQuerySyntaxImpl
missing: StandardSyntaxParser
../../lucene/build/docs/api/all/org/apache/lucene/queryParser/surround/query/package-summary.html
missing: DistanceSubQuery
missing: SimpleTerm.MatchingTermVisitor
missing: AndQuery
missing: BasicQueryFactory
missing: ComposedQuery
missing: DistanceQuery
missing: FieldsQuery
missing: NotQuery
missing: OrQuery
missing: SimpleTerm
missing: SpanNearClauseFactory
missing: SrndPrefixQuery
missing: SrndQuery
missing: SrndTermQuery
missing: SrndTruncQuery
missing: TooManyBasicQueries
../../lucene/build/docs/api/all/org/apache/lucene/store/package-summary.html
missing: FSDirectory.FSIndexOutput
missing: NativePosixUtil
missing: NIOFSDirectory.NIOFSIndexInput
missing: RAMFile
missing: SimpleFSDirectory.SimpleFSIndexInput
missing: SimpleFSDirectory.SimpleFSIndexInput.Descriptor
missing: WindowsDirectory.WindowsIndexInput
missing: MockDirectoryWrapper.Throttling
../../lucene/build/docs/api/all/org/apache/lucene/xmlparser/package-summary.html
missing: FilterBuilder
missing: CorePlusExtensionsParser
missing: DOMUtils
missing: FilterBuilderFactory
missing: QueryBuilderFactory
missing: ParserException
../../lucene/build/docs/api/all/org/apache/lucene/xmlparser/builders/package-summary.html
missing: SpanQueryBuilder
missing: BooleanFilterBuilder
missing: BooleanQueryBuilder
missing: BoostingQueryBuilder
missing: BoostingTermBuilder
missing: ConstantScoreQueryBuilder
missing: DuplicateFilterBuilder
missing: FilteredQueryBuilder
missing: FuzzyLikeThisQueryBuilder
missing: LikeThisQueryBuilder
missing: MatchAllDocsQueryBuilder
missing: RangeFilterBuilder
missing: SpanBuilderBase
missing: SpanFirstBuilder
missing: SpanNearBuilder
missing: SpanNotBuilder
missing: SpanOrBuilder
missing: SpanOrTermsBuilder
missing: SpanQueryBuilderFactory
missing: SpanTermBuilder
missing: TermQueryBuilder
missing: TermsFilterBuilder
../../lucene/build/docs/api/all/org/apache/lucene/benchmark/byTask/tasks/package-summary.html
missing: BenchmarkHighlighter
missing: NewCollationAnalyzerTask.Implementation
../../lucene/build/docs/api/all/org/apache/lucene/benchmark/byTask/feeds/demohtml/package-summary.html
missing: Entities
missing: HTMLParser
missing: Tags
../../lucene/build/docs/api/all/org/apache/lucene/search/package-summary.html
missing: DuplicateFilter
missing: FieldCache.CreationPlaceholder
missing: FieldComparator.NumericComparator<T extends Number>
missing: FieldValueHitQueue.Entry
missing: QueryTermVector
missing: ScoringRewrite<Q extends Query>
missing: SpanFilterResult.PositionInfo
missing: SpanFilterResult.StartEnd
missing: TimeLimitingCollector.TimerThread
../../lucene/build/docs/api/all/org/apache/lucene/search/vectorhighlight/package-summary.html
missing: BoundaryScanner
missing: BaseFragmentsBuilder
missing: FieldFragList.WeightedFragInfo
missing: FieldFragList.WeightedFragInfo.SubInfo
missing: FieldPhraseList.WeightedPhraseInfo
missing: FieldPhraseList.WeightedPhraseInfo.Toffs
missing: FieldQuery.QueryPhraseMap
missing: FieldTermStack.TermInfo
missing: ScoreOrderFragmentsBuilder.ScoreComparator
missing: SimpleBoundaryScanner
../../lucene/build/docs/api/all/org/apache/lucene/search/highlight/package-summary.html
missing: TokenStreamFromTermPositionVector
../../lucene/build/docs/api/all/org/apache/lucene/search/suggest/package-summary.html
missing: Lookup.LookupPriorityQueue
../../lucene/build/docs/api/all/org/apache/lucene/search/suggest/jaspell/package-summary.html
missing: JaspellLookup
../../lucene/build/docs/api/all/org/apache/lucene/search/suggest/tst/package-summary.html
missing: TSTAutocomplete
missing: TSTLookup
../../lucene/build/docs/api/all/org/apache/lucene/facet/index/package-summary.html
missing: FacetsPayloadProcessorProvider.FacetsDirPayloadProcessor
../../lucene/build/docs/api/all/org/apache/lucene/facet/taxonomy/writercache/lru/package-summary.html
missing: LruTaxonomyWriterCache.LRUType
{noformat}
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
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]
