[
https://issues.apache.org/jira/browse/LUCENE-6675?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14625052#comment-14625052
]
Michael McCandless commented on LUCENE-6675:
--------------------------------------------
Oh, hmm: it seems like you lost my fixes to checkJavadocs.py in your last
patch? When I applied those again and re-run {{ant documentation-lint}} I get
this:
{noformat}
-documentation-lint:
[echo] checking for broken html...
[jtidy] Checking for broken html (such as invalid tags)...
[delete] Deleting directory /l/geo3d/lucene/build/jtidy_tmp
[echo] Checking for broken links...
[exec]
[exec] Crawl/parse...
[exec]
[exec] Verify...
[echo] Checking for missing docs...
[exec]
[exec] build/docs/spatial3d/org/apache/lucene/geo3d/ArcDistance.html
[exec] missing Constructors: ArcDistance--
[exec]
[exec]
build/docs/spatial3d/org/apache/lucene/geo3d/GeoPath.PathSegment.html
[exec] missing Constructors:
PathSegment-org.apache.lucene.geo3d.PlanetModel-org.apache.lucene.geo3d.GeoPoint-org.apache.lucene.geo3d.GeoPoint-org.apache.lucene.geo3d.Plane-double-
[exec]
[exec]
build/docs/spatial3d/org/apache/lucene/geo3d/GeoWideDegenerateHorizontalLine.html
[exec] missing Nested Classes:
GeoWideDegenerateHorizontalLine.EitherBound
[exec] missing Fields: centerPoint
[exec] missing Fields: edgePoints
[exec] missing Fields: eitherBound
[exec] missing Fields: latitude
[exec] missing Fields: leftLon
[exec] missing Fields: leftPlane
[exec] missing Fields: LHC
[exec] missing Fields: plane
[exec] missing Fields: planePoints
[exec] missing Fields: RHC
[exec] missing Fields: rightLon
[exec] missing Fields: rightPlane
[exec]
[exec]
build/docs/spatial3d/org/apache/lucene/geo3d/GeoWideDegenerateHorizontalLine.EitherBound.html
[exec] missing Constructors: EitherBound--
[exec]
[exec]
build/docs/spatial3d/org/apache/lucene/geo3d/GeoWideLongitudeSlice.html
[exec] missing Fields: centerPoint
[exec] missing Fields: edgePoints
[exec] missing Fields: leftLon
[exec] missing Fields: leftPlane
[exec] missing Fields: planePoints
[exec] missing Fields: rightLon
[exec] missing Fields: rightPlane
[exec]
[exec]
build/docs/spatial3d/org/apache/lucene/geo3d/GeoWideNorthRectangle.html
[exec] missing Nested Classes: GeoWideNorthRectangle.EitherBound
[exec] missing Fields: bottomLat
[exec] missing Fields: bottomPlane
[exec] missing Fields: bottomPlanePoints
[exec] missing Fields: centerPoint
[exec] missing Fields: cosMiddleLat
[exec] missing Fields:
{noformat}
I will commit what we have so far, except for the build.xml change that enables
javadocs linting for spatial3d module. Patch back and forth is too heavy ...
> Spatial3d javadocs don't pass "ant documentation-lint"
> ------------------------------------------------------
>
> Key: LUCENE-6675
> URL: https://issues.apache.org/jira/browse/LUCENE-6675
> Project: Lucene - Core
> Issue Type: Bug
> Reporter: Michael McCandless
> Fix For: 5.3, Trunk
>
> Attachments: LUCENE-6675.patch, LUCENE-6675.patch, LUCENE-6675.patch,
> LUCENE-6675.patch
>
>
> Spinoff from LUCENE-6607.
> With the attached patch, if you run {{ant documentation-lint}} from
> top-level, it hits these javadoc linting problems:
> {noformat}
> [exec] build/docs/spatial3d/org/apache/lucene/geo3d/ArcDistance.html
> [exec] missing Fields: INSTANCE
> [exec] missing Constructors: INSTANCE
> [exec]
> [exec] build/docs/spatial3d/org/apache/lucene/geo3d/BasePlanetObject.html
> [exec] missing Fields: planetModel
> [exec] missing Constructors: planetModel
> [exec]
> [exec] build/docs/spatial3d/org/apache/lucene/geo3d/Bounds.html
> [exec] Traceback (most recent call last):
> [exec] File "/l/trunk/dev-tools/scripts/checkJavaDocs.py", line 384,
> in <module>
> [exec] if checkPackageSummaries(sys.argv[1], level):
> [exec] File "/l/trunk/dev-tools/scripts/checkJavaDocs.py", line 364,
> in checkPackageSummaries
> [exec] if checkClassSummaries(fullPath):
> [exec] File "/l/trunk/dev-tools/scripts/checkJavaDocs.py", line 225,
> in checkClassSummaries
> [exec] raise RuntimeError('failed to locate javadoc item in %s, line
> %d? last line: %s' % (fullPath, lineCount, line.rstrip())) missing Fields:
> leftLongitude
> [exec]
> [exec] missing Fields: maxLatitude
> [exec] missing Fields: minLatitude
> [exec] missing Fields: noBottomLatitudeBound
> [exec] missing Fields: noLongitudeBound
> [exec] missing Fields: noTopLatitudeBound
> [exec] missing Fields: rightLongitude
> [exec] missing Constructors: rightLongitude
> [exec] missing Methods: addHorizontalCircle-double-
> [exec] missing Methods: addLatitudeBound-double-
> [exec] missing Methods: addLatitudeZone-double-
> [exec] RuntimeError: failed to locate javadoc item in
> build/docs/spatial3d/org/apache/lucene/geo3d/GeoBaseDistanceShape.html, line
> 177? last line: </tr> missing Methods: addLongitudeBound-double-
> [exec]
> [exec] missing Methods: addLongitudeBound-double-double-
> [exec] missing Methods: addLongitudeSlice-double-double-
> [exec] missing Methods: addPoint-double-double-
> [exec] missing Methods: addPoint-double-double-double-
> [exec] missing Methods: addPoint-org.apache.lucene.geo3d.Vector-
> [exec] missing Methods: checkNoBottomLatitudeBound--
> [exec] missing Methods: checkNoLongitudeBound--
> [exec] missing Methods: checkNoTopLatitudeBound--
> [exec] missing Methods: getLeftLongitude--
> [exec] missing Methods: getMaxLatitude--
> [exec] missing Methods: getMinLatitude--
> [exec] missing Methods: getRightLongitude--
> [exec] missing Methods: noBottomLatitudeBound--
> [exec] missing Methods: noLongitudeBound--
> [exec] missing Methods: noTopLatitudeBound--
> [exec]
> [exec] build/docs/spatial3d/org/apache/lucene/geo3d/DistanceStyle.html
> [exec] missing Fields: ARC
> [exec] missing Fields: LINEAR
> [exec] missing Fields: LINEAR_SQUARED
> [exec] missing Fields: NORMAL
> [exec] missing Fields: NORMAL_SQUARED
> [exec]
> [exec] build/docs/spatial3d/org/apache/lucene/geo3d/GeoArea.html
> [exec] missing Fields: CONTAINS
> [exec] missing Fields: DISJOINT
> [exec] missing Fields: OVERLAPS
> [exec] missing Fields: WITHIN
> [exec]
> [exec] build/docs/spatial3d/org/apache/lucene/geo3d/GeoBaseBBox.html
> [exec] missing Fields: ALL_INSIDE
> [exec] missing Fields: NONE_INSIDE
> [exec] missing Fields: SOME_INSIDE
> [exec] missing Constructors: SOME_INSIDE
> [exec] missing Methods:
> isShapeInsideBBox-org.apache.lucene.geo3d.GeoShape-
> {noformat}
> Maybe we can fix the javadocs?
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
