[BUG] Java Doc Warnings on CI

[saratvemulapalli]

What is the bug?
CI runs are throwing out Java Doc warnings
As part of the issue, lets move the Java doc to strict to ensure PR checks fail when new Java Docs are not added.

> Task :javadoc
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/scheduler/JobScheduler.java:42: warning: no comment
    public JobScheduler(ThreadPool threadPool, final LockService lockService) {
           ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/scheduler/JobScheduler.java:86: warning: no comment
    public List<String> bulkDeschedule(String indexName, Collection<String> ids) {
                        ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/scheduler/JobScheduler.java:100: warning: no comment
    public boolean deschedule(String indexName, String id) {
                   ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/scheduler/JobScheduler.java:59: warning: no comment
    public Set<String> getScheduledJobIds(String indexName) {
                       ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/scheduler/JobScheduler.java:63: warning: no comment
    public boolean schedule(String indexName, String docId, ScheduledJobParameter scheduledJobParameter,
                   ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/JobSchedulerPlugin.java:50: warning: no comment
public class JobSchedulerPlugin extends Plugin implements ExtensiblePlugin {
       ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/JobSchedulerPlugin.java:52: warning: no comment
    public static final String OPEN_DISTRO_JOB_SCHEDULER_THREAD_POOL_NAME = "open_distro_job_scheduler";
                               ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/JobSchedulerPlugin.java:62: warning: no comment
    public JobSchedulerPlugin() {
           ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/JobSchedulerSettings.java:11: warning: no comment
public class JobSchedulerSettings {
       ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/JobSchedulerSettings.java:37: warning: no comment
    public static final Setting<Double> JITTER_LIMIT = Setting.doubleSetting(
                                        ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/JobSchedulerSettings.java:12: warning: no comment
    public static final Setting<TimeValue> REQUEST_TIMEOUT = Setting.positiveTimeSetting(
                                           ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/JobSchedulerSettings.java:17: warning: no comment
    public static final Setting<TimeValue> SWEEP_BACKOFF_MILLIS = Setting.positiveTimeSetting(
                                           ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/JobSchedulerSettings.java:22: warning: no comment
    public static final Setting<Integer> SWEEP_BACKOFF_RETRY_COUNT = Setting.intSetting(
                                         ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/JobSchedulerSettings.java:32: warning: no comment
    public static final Setting<Integer> SWEEP_PAGE_SIZE = Setting.intSetting(
                                         ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/JobSchedulerSettings.java:27: warning: no comment
    public static final Setting<TimeValue> SWEEP_PERIOD = Setting.positiveTimeSetting(
                                           ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/sweeper/JobSweeper.java:95: warning: no comment
    public JobSweeper(Settings settings, Client client, ClusterService clusterService, ThreadPool threadPool,
           ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/LegacyOpenDistroJobSchedulerSettings.java:11: warning: no comment
public class LegacyOpenDistroJobSchedulerSettings {
       ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/LegacyOpenDistroJobSchedulerSettings.java:37: warning: no comment
    public static final Setting<Double> JITTER_LIMIT = Setting.doubleSetting(
                                        ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/LegacyOpenDistroJobSchedulerSettings.java:12: warning: no comment
    public static final Setting<TimeValue> REQUEST_TIMEOUT = Setting.positiveTimeSetting(
                                           ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/LegacyOpenDistroJobSchedulerSettings.java:17: warning: no comment
    public static final Setting<TimeValue> SWEEP_BACKOFF_MILLIS = Setting.positiveTimeSetting(
                                           ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/LegacyOpenDistroJobSchedulerSettings.java:22: warning: no comment
    public static final Setting<Integer> SWEEP_BACKOFF_RETRY_COUNT = Setting.intSetting(
                                         ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/LegacyOpenDistroJobSchedulerSettings.java:32: warning: no comment
    public static final Setting<Integer> SWEEP_PAGE_SIZE = Setting.intSetting(
                                         ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/LegacyOpenDistroJobSchedulerSettings.java:27: warning: no comment
    public static final Setting<TimeValue> SWEEP_PERIOD = Setting.positiveTimeSetting(
                                           ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/scheduler/ScheduledJobInfo.java:36: warning: no comment
    public void addJob(String indexName, String jobId, JobSchedulingInfo jobInfo) {
                ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/scheduler/ScheduledJobInfo.java:32: warning: no comment
    public JobSchedulingInfo getJobInfo(String indexName, String jobId) {
                             ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/scheduler/ScheduledJobInfo.java:21: warning: no comment
    public Map<String, JobSchedulingInfo> getJobsByIndex(String indexName) {
                                          ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/scheduler/ScheduledJobInfo.java:[48](https://github.com/opensearch-project/job-scheduler/actions/runs/3237630000/jobs/5304921381#step:4:49): warning: no comment
    public JobSchedulingInfo removeJob(String indexName, String jobId) {
                             ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/ScheduledJobProvider.java:11: warning: no comment
public class ScheduledJobProvider {
       ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/ScheduledJobProvider.java:33: warning: no comment
    public ScheduledJobProvider(String jobType, String jobIndexName, ScheduledJobParser jobParser, ScheduledJobRunner jobRunner) {
           ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/ScheduledJobProvider.java:21: warning: no comment
    public String getJobIndexName() {
                  ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/ScheduledJobProvider.java:25: warning: no comment
    public ScheduledJobParser getJobParser() {
                              ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/ScheduledJobProvider.java:29: warning: no comment
    public ScheduledJobRunner getJobRunner() {
                              ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/ScheduledJobProvider.java:17: warning: no comment
    public String getJobType() {
                  ^
/home/runner/work/job-scheduler/job-scheduler/src/main/java/org/opensearch/jobscheduler/utils/VisibleForTesting.java:8: warning: no comment
public @interface VisibleForTesting {
        ^

How can one reproduce the bug?
./gradlew build

What is the expected behavior?
No warnings :)

Example Run: https://github.com/opensearch-project/job-scheduler/actions/runs/3237630000/jobs/5318660430

[kirsteend]

@saratvemulapalli I'd like to work on this if you are still looking for contributors.

[saratvemulapalli]

@kirsteend absolutely, thank you for picking this up.

[kirsteend]

@saratvemulapalli Do you want me to stub in javadocs for the existing warnings too? Otherwise builds will start failing 😢

[saratvemulapalli]

@kirsteend ideally yeah. It's a one time effort to add the Java docs and get rid of warnings and turning on Java doc strict will help the repo be sane.

[abermu3]

Hello, was this issue ever resolved? I would like to work through it.

[saratvemulapalli]

@abermu3 we haven't merged any changes, absolutely all yours!