OAK-8892: Add javadoc to package-info files #175
Conversation
| */ | ||
|
|
||
| /** | ||
| * This package contains tokenization related classes. |
There was a problem hiding this comment.
I believe "FV" stands for "feature vector", and I think that should be added in the package documentation. And probably a link to https://en.wikipedia.org/wiki/Feature_(machine_learning). The documentation about this in Oak is here: http://jackrabbit.apache.org/oak/docs/query/lucene.html#similar-fv - maybe you want to read this as well and update the Javadocs a bit.
| */ | ||
|
|
||
| /** | ||
| * This package contains index creation and editing related classes and interfaces. |
There was a problem hiding this comment.
"editing related" is not the right term I think... The word "edit" comes from the oak "Editor", which is the mechanism used to observe changes (like a "trigger" in a relational database).
I would write something like "Contains classes that deal with updating indexes, including how to build indexing backend documents (e.g. Lucene documents)".
* updating as per review comments
* Adding one more package-info file
|
This PR is stale because it has been open 24 months with no activity. Remove stale label or comment or this will be closed in 30 days. |
No description provided.