gchq / gchq/sleeper

Correct warnings from within the Javadoc validation

Open
#7,088 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Java
Stars
107
Forks
29
Avg merge
19h 46m
Merged PRs (30d)
141

Description

Parent issue:
- https://github.com/gchq/sleeper/issues/6844

We want to correct all the warnings flagged within the javadoc when executing the following command:

mvn javadoc:javadoc
(also run as part of the "java build status" github action)

Errors can be ignored as part of this ticket as there is a separate ticket for them:
- https://github.com/gchq/sleeper/issues/7086

Majority if not all of the warnings flagged are for: "warning: no comment", one solution may be to remove this check if possible as they may not be required.
In table below several modules are flagged with a *, these presently report 100 warnings but given the exacting number this is likely a hard limit within javadoc for the reporting and the actual number for that module may be greater.

Once all warnings are fixed we can remove the flag from within the parent pom for the module.

### Modules to fix ###

| Module name | Error count | Warning count |
|-----------------|-------------|-----------------|
|system-test-drivers|6|0|
|trino|5|71|
|splitter|4|90|
|athena|4|25|
|core|3|100*|
|foreign-bridge|2|13|
|bulk-export-core|1|15|
|compaction-task-creation|1|4|
|query-datafusions|1|2|
|build-uptime-lambda|0|43|
|bulk-export-planner|0|5|
|bulk-export-task-creator|0|1|
|bulk-export-task-execution|0|2|
|bulk-import-runner|0|82|
|bulk-import-starter|0|57|
|cdk-custom-resources|0|57|
|cdk-environment|0|100*|
|common-invoke-tables|0|1|
|common-job|0|25|
|common-task|0|67|
|compaction-datafusion|0|3|
|compaction-job-creation|0|11|
|compaction-job-creation-lambda|0|3|
|compaction-job-execution|0|20|
|compaction-tracker|0|46|
|configuration|0|10|
|dynamodb-tools|0|47|
|garbage-collector|0|24|
|ingest-batcher-job-creator|0|6|
|ingest-batcher-store|0|20|
|ingest-batcher-submitter|0|10|
|ingest-runner|0|100*|
|ingest-taskrunner|0|2|
|ingest-tracker|0|45|
|localstack-test|0|43|
|metrics|0|5|
|parquet|0|29|
|query-lambda|0|38|
|query-runner|0|96|
|sketches|0|36|
|spark|0|29|
|splitter-lambda|0|7|
|statestore|0|61|
|statestore-committer|0|3|
|statestore-lambda|0|18|
|system-test-configuration|0|100*|
|system-test-data-generation|0|43|
|system-test-dsl|0|100*|
|system-test-suite|0|15|

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.