[ https://issues.apache.org/jira/browse/LUCENE-3887?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13235574#comment-13235574 ]
Michael McCandless commented on LUCENE-3887: -------------------------------------------- You can also just run the javadoc checker directly in a source checkout, like this: {noformat} python -u dev-tools/scripts/checkJavaDocs.py /lucene/3x/lucene/build {noformat} You have to "ant javadocs" first yourself. Right now it only checks for missing sentences in the package-summary.html... I'll see if I can fix it to also detect missing package.html's... Here's what it reports on 3.x right now: {noformat} /lucene/3x/lucene/build/docs/api/contrib-highlighter/org/apache/lucene/search/highlight/package-summary.html missing: TokenStreamFromTermPositionVector /lucene/3x/lucene/build/docs/api/contrib-highlighter/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/3x/lucene/build/docs/api/contrib-spatial/org/apache/lucene/spatial/tier/package-summary.html missing: DistanceHandler.Precision /lucene/3x/lucene/build/docs/api/contrib-spellchecker/org/apache/lucene/search/suggest/package-summary.html missing: Lookup.LookupPriorityQueue /lucene/3x/lucene/build/docs/api/contrib-spellchecker/org/apache/lucene/search/suggest/jaspell/package-summary.html missing: JaspellLookup /lucene/3x/lucene/build/docs/api/contrib-spellchecker/org/apache/lucene/search/suggest/tst/package-summary.html missing: TSTAutocomplete missing: TSTLookup /lucene/3x/lucene/build/docs/api/contrib-pruning/org/apache/lucene/index/pruning/package-summary.html missing: CarmelTopKTermPruningPolicy.ByDocComparator missing: CarmelUniformTermPruningPolicy.ByDocComparator /lucene/3x/lucene/build/docs/api/contrib-facet/org/apache/lucene/facet/taxonomy/writercache/lru/package-summary.html missing: LruTaxonomyWriterCache.LRUType /lucene/3x/lucene/build/docs/api/contrib-facet/org/apache/lucene/facet/index/package-summary.html missing: FacetsPayloadProcessorProvider.FacetsDirPayloadProcessor /lucene/3x/lucene/build/docs/api/core/org/apache/lucene/store/package-summary.html missing: FSDirectory.FSIndexOutput missing: NIOFSDirectory.NIOFSIndexInput missing: RAMFile missing: SimpleFSDirectory.SimpleFSIndexInput missing: SimpleFSDirectory.SimpleFSIndexInput.Descriptor /lucene/3x/lucene/build/docs/api/core/org/apache/lucene/index/package-summary.html missing: MergePolicy.MergeAbortedException /lucene/3x/lucene/build/docs/api/core/org/apache/lucene/search/package-summary.html 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/3x/lucene/build/docs/api/core/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: OpenBitSetDISI missing: PagedBytes.Reader missing: UnicodeUtil.UTF16Result missing: UnicodeUtil.UTF8Result /lucene/3x/lucene/build/docs/api/contrib-analyzers/org/tartarus/snowball/package-summary.html missing: Among missing: TestApp /lucene/3x/lucene/build/docs/api/contrib-xml-query-parser/org/apache/lucene/xmlparser/package-summary.html missing: FilterBuilder missing: CorePlusExtensionsParser missing: DOMUtils missing: FilterBuilderFactory missing: QueryBuilderFactory missing: ParserException /lucene/3x/lucene/build/docs/api/contrib-xml-query-parser/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/3x/lucene/build/docs/api/contrib-misc/org/apache/lucene/store/package-summary.html missing: NativePosixUtil missing: WindowsDirectory.WindowsIndexInput /lucene/3x/lucene/build/docs/api/test-framework/org/apache/lucene/store/package-summary.html missing: MockDirectoryWrapper.Throttling /lucene/3x/lucene/build/docs/api/test-framework/org/apache/lucene/util/package-summary.html missing: English missing: StoreClassNameRule missing: SystemPropertiesInvariantRule missing: UncaughtExceptionsRule.UncaughtExceptionEntry /lucene/3x/lucene/build/docs/api/contrib-benchmark/org/apache/lucene/benchmark/byTask/feeds/demohtml/package-summary.html missing: Entities missing: HTMLParser missing: Tags /lucene/3x/lucene/build/docs/api/contrib-benchmark/org/apache/lucene/benchmark/byTask/tasks/package-summary.html missing: BenchmarkHighlighter missing: NewCollationAnalyzerTask.Implementation /lucene/3x/lucene/build/docs/api/contrib-queries/org/apache/lucene/search/package-summary.html missing: DuplicateFilter /lucene/3x/lucene/build/docs/api/contrib-queryparser/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/3x/lucene/build/docs/api/contrib-queryparser/org/apache/lucene/queryParser/core/parser/package-summary.html missing: EscapeQuerySyntax.Type /lucene/3x/lucene/build/docs/api/contrib-queryparser/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/3x/lucene/build/docs/api/contrib-queryparser/org/apache/lucene/queryParser/standard/parser/package-summary.html missing: EscapeQuerySyntaxImpl missing: StandardSyntaxParser /lucene/3x/lucene/build/docs/api/contrib-queryparser/org/apache/lucene/queryParser/standard/config/package-summary.html missing: FuzzyConfig missing: StandardQueryConfigHandler.ConfigurationKeys missing: DefaultOperatorAttribute.Operator missing: StandardQueryConfigHandler.Operator /lucene/3x/lucene/build/docs/api/contrib-queryparser/org/apache/lucene/queryParser/standard/builders/package-summary.html missing: AnyQueryNodeBuilder {noformat} > 'ant javadocs' should fail if a package is missing a package.html > ----------------------------------------------------------------- > > Key: LUCENE-3887 > URL: https://issues.apache.org/jira/browse/LUCENE-3887 > Project: Lucene - Java > Issue Type: Task > Components: general/build > Reporter: Robert Muir > Attachments: LUCENE-3887.patch, LUCENE-3887.patch > > > While reviewing the javadocs I noticed many packages are missing a basic > package.html. > For 3.x I committed some package.html files where they were missing (I will > port forward to trunk). > I think all packages should have this... really all public/protected > classes/methods/constants, > but this would be a good step. -- 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: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org