Write the javadoc of the object layer and the R-tree search operators as javadoc reads it - #118
Open
estebanzimanyi wants to merge 1 commit into
Open
estebanzimanyi wants to merge 1 commit into
estebanzimanyi wants to merge 1 commit into
Conversation
… as javadoc reads it ObjectLayerGenerator names the object-model class a generated interface serves as code, not as a link: the class is a MEOS object-model key, and TBigint, TNumber, TInt and TFloat are not types the generated package imports. RTreeSearchOp documents each operator in a javadoc comment before its constant. Witness. The build reported 33 javadoc warnings: "reference not found" for TBigint, TFloat, TInt and TNumber, six times each, and "invalid input: '<'" for the three trailing /**< comments of RTreeSearchOp, three times each. Measured. Against the catalog and libmeos of MobilityDB 8a23781e4c with MEOS-API 8dddf59, the build reports no javadoc warning, and the suites run 106 and 1,810 tests, all passing.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
ObjectLayerGenerator names the object-model class a generated interface serves as code, not
as a link: the class is a MEOS object-model key, and TBigint, TNumber, TInt and TFloat are not
types the generated package imports. RTreeSearchOp documents each operator in a javadoc
comment before its constant.
Witness. The build reported 33 javadoc warnings: "reference not found" for TBigint, TFloat,
TInt and TNumber, six times each, and "invalid input: '<'" for the three trailing /**<
comments of RTreeSearchOp, three times each.
Measured. Against the catalog and libmeos of MobilityDB 8a23781e4c with MEOS-API 8dddf59,
the build reports no javadoc warning, and the suites run 106 and 1,810 tests, all passing.