gchq / gchq/sleeper

Add missing Javadoc in clients/admin package

Open
#6,289 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Java
Stars
107
Forks
29
Avg merge
19h 46m
Merged PRs (30d)
141

Description

### Background
Under epic:

- #2092

### Split from:

- #2091

### Description
We'd like to add missing Javadoc for the clients/admin module.

### Analysis
We can start by removing the Checkstyle suppression for this, for both missingJavadocMethod and missingJavadocType.

Contributor guide

Open the contributing guide

Research direction

Start by locating the clients/admin package and the Checkstyle configuration entries suppressing missingJavadocMethod and missingJavadocType. Remove those suppressions, add the required Javadoc throughout the affected package, and run the relevant Checkstyle or project validation to confirm the package passes without them.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.