6f893ed1cd
* Adds a gradle plugin to validate missing javadocs Use `./gradlew missingJavadoc` to validate missing javadocs. Currently this task fails because several modules are missing appropriate javadocs. Once added, this should pass. Also, precommit PomValidation check currently fails with missing Javadoc plugin, that needs to be fixed - https://github.com/opensearch-project/OpenSearch/issues/449 Thus keeping this in a separate feature branch. Signed-off-by: Himanshu Setia <setiah@amazon.com> * Fix Javadoc errors in module `client/rest` (#685) * Fix Javadoc errors in client/rest module Signed-off-by: Gregor Zurowski <gregor@zurowski.org> * Add package info file in client/rest module Signed-off-by: Gregor Zurowski <gregor@zurowski.org> * Fix typos Signed-off-by: Gregor Zurowski <gregor@zurowski.org> * Add exception documentation to Javadoc Signed-off-by: Gregor Zurowski <gregor@zurowski.org> * Fixes precommit task configuration failures due to newly added missin… (#707) * Fixes precommit task configuration failures due to newly added missingJavadoc task Signed-off-by: Himanshu Setia <setiah@amazon.com> * Fixes javadoc task errors due to PR#685 Signed-off-by: Himanshu Setia <setiah@amazon.com> * Updated CONTRIBUTING.md for info on javadocs Signed-off-by: Himanshu Setia <setiah@amazon.com> * Correcting licenses and naming Signed-off-by: Himanshu Setia <setiah@amazon.com> * Correcting version info Signed-off-by: Himanshu Setia <setiah@amazon.com> Co-authored-by: Gregor Zurowski <gregor@zurowski.org> |
||
|---|---|---|
| .. | ||
| benchmark | ||
| client-benchmark-noop-api-plugin | ||
| rest | ||
| rest-high-level | ||
| sniffer | ||
| test | ||
| transport | ||