Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

-Xdoclint:all,-missing #356

Merged
merged 1 commit into from
Oct 2, 2020
Merged

-Xdoclint:all,-missing #356

merged 1 commit into from
Oct 2, 2020

Conversation

jglick
Copy link
Member

@jglick jglick commented Oct 1, 2020

Implements my suggestion of jenkins-infra/pipeline-library#154 (comment) to avoid spammy build logs and spammy Checks tab annotations. See documentation. On jenkinsci/workflow-cps-plugin@261df12 using AdoptOpenJDK 1.8.0_265 (see why you should not use Ubuntu’s package), this reduced the log spam from

[INFO] No previous run data found, generating javadoc.
[INFO] 
69 warnings
[WARNING] Javadoc Warnings
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsClosure2.java:34: warning: no @param for arg
[WARNING] public Object sleep(long arg) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsClosure2.java:34: warning: no @return
[WARNING] public Object sleep(long arg) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowDefinition.java:76: warning: no @param for script
[WARNING] public CpsFlowDefinition(String script) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.java:466: warning: no @return
[WARNING] public GroovyShell getShell() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.java:475: warning: no @return
[WARNING] public GroovyShell getTrustedShell() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.java:494: warning: no @return
[WARNING] public boolean isSandbox() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.java:516: warning: no @return
[WARNING] public File getStorageDir() throws IOException {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.java:516: warning: no @throws for java.io.IOException
[WARNING] public File getStorageDir() throws IOException {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.java:591: warning: no @return
[WARNING] public String iotaStr() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.java:708: warning: no @return
[WARNING] public boolean canResume() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.java:773: warning: no description for @param
[WARNING] * @param programDataFile
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.java:963: warning: no @throws for java.lang.InterruptedException
[WARNING] public void waitForSuspension() throws InterruptedException, ExecutionException {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.java:963: warning: no @throws for java.util.concurrent.ExecutionException
[WARNING] public void waitForSuspension() throws InterruptedException, ExecutionException {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.java:1040: warning: no @return
[WARNING] public CpsThreadDump getThreadDump() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.java:1221: warning: no @param for node
[WARNING] public static void maybeAutoPersistNode(@Nonnull FlowNode node) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.java:1517: warning: no @return
[WARNING] public String getNextScriptName(String path) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.java:1524: warning: no @return
[WARNING] public boolean isDoneFlagSet() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.java:1549: warning: no @throws for java.io.IOException
[WARNING] public void pause(final boolean v) throws IOException {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsScript.java:241: warning: no @param for arg
[WARNING] public Object sleep(long arg) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsScript.java:241: warning: no @return
[WARNING] public Object sleep(long arg) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsScript.java:65: warning: no @throws for java.io.IOException
[WARNING] public CpsScript() throws IOException {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsThread.java:284: warning: no @param for v
[WARNING] public Future<Object> resume(Outcome v) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsThread.java:303: warning: no @param for t
[WARNING] public void stop(Throwable t) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsThread.java:342: warning: no @return
[WARNING] public static CpsThread current() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsThreadDump.java:148: warning: no @return
[WARNING] public static @Nonnull CpsThreadDump fromText(@Nonnull final String text) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsThreadDump.java:73: warning: no @return
[WARNING] public List<StackTraceElement> getStackTrace() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsThreadDump.java:65: warning: no @param for t
[WARNING] public ThreadInfo(Throwable t) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsThreadGroup.java:221: warning: no @param for id
[WARNING] public CpsThread getThread(int id) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsThreadGroup.java:232: warning: no @return
[WARNING] public Iterable<CpsThread> getThreads() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsThreadGroup.java:375: warning: no @return
[WARNING] public boolean isPaused() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/DSL.java:129: warning: no @return
[WARNING] public static boolean isKeepStepArguments() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/DSL.java:209: warning: no @param for d
[WARNING] protected Object invokeStep(StepDescriptor d, Object args) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/DSL.java:209: warning: no @param for args
[WARNING] protected Object invokeStep(StepDescriptor d, Object args) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/DSL.java:209: warning: no @return
[WARNING] protected Object invokeStep(StepDescriptor d, Object args) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/DSL.java:219: warning: no @return
[WARNING] protected Object invokeStep(StepDescriptor d, String name, Object args) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/DSL.java:343: warning: no @param for symbol
[WARNING] protected Object invokeDescribable(String symbol, Object _args) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/DSL.java:343: warning: no @param for _args
[WARNING] protected Object invokeDescribable(String symbol, Object _args) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/DSL.java:343: warning: no @return
[WARNING] protected Object invokeDescribable(String symbol, Object _args) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/EnvActionImpl.java:157: warning: no @param for run
[WARNING] public static @Nonnull EnvActionImpl forRun(@Nonnull Run<?,?> run) throws IOException {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/EnvActionImpl.java:157: warning: no @return
[WARNING] public static @Nonnull EnvActionImpl forRun(@Nonnull Run<?,?> run) throws IOException {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/EnvActionImpl.java:157: warning: no @throws for java.io.IOException
[WARNING] public static @Nonnull EnvActionImpl forRun(@Nonnull Run<?,?> run) throws IOException {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/GroovyShellDecorator.java:25: warning: no @param for ic
[WARNING] public void customizeImports(@CheckForNull CpsFlowExecution context, ImportCustomizer ic) {}
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/GroovyShellDecorator.java:33: warning: no @param for cc
[WARNING] public void configureCompiler(@CheckForNull CpsFlowExecution context, CompilerConfiguration cc) {}
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/GroovyShellDecorator.java:39: warning: no @param for shell
[WARNING] public void configureShell(@CheckForNull CpsFlowExecution context, GroovyShell shell) {}
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/GroovyShellDecorator.java:50: warning: no @return
[WARNING] public GroovyShellDecorator forTrusted() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/ThreadTask.java:60: warning: no @return
[WARNING] protected abstract ThreadTaskResult eval(CpsThread cur);
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/Snippetizer.java:547: warning: no @return
[WARNING] public List<SnippetizerLink> getSnippetizerLinks() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/SnippetizerLink.java:57: warning: no @return
[WARNING] public abstract String getUrl();
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/SnippetizerLink.java:64: warning: no @return
[WARNING] public final String getDisplayUrl() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/SnippetizerLink.java:110: warning: no @return
[WARNING] public String getIcon() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/SnippetizerLink.java:118: warning: no @return
[WARNING] public abstract String getDisplayName();
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/SnippetizerLink.java:123: warning: no @return
[WARNING] public boolean inNewWindow() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/persistence/IteratorHack.java:93: warning: no @param for <E>
[WARNING] public static <E> Iterator<E> iterator(List<E> list) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/persistence/IteratorHack.java:93: warning: no @param for list
[WARNING] public static <E> Iterator<E> iterator(List<E> list) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/persistence/IteratorHack.java:93: warning: no @return
[WARNING] public static <E> Iterator<E> iterator(List<E> list) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/persistence/IteratorHack.java:165: warning: no @param for <K>
[WARNING] public static <K, V> Set<Map.Entry<K, V>> entrySet(Map<K, V> map) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/persistence/IteratorHack.java:165: warning: no @param for <V>
[WARNING] public static <K, V> Set<Map.Entry<K, V>> entrySet(Map<K, V> map) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/persistence/IteratorHack.java:165: warning: no @param for map
[WARNING] public static <K, V> Set<Map.Entry<K, V>> entrySet(Map<K, V> map) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/persistence/IteratorHack.java:165: warning: no @return
[WARNING] public static <K, V> Set<Map.Entry<K, V>> entrySet(Map<K, V> map) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/actions/ArgumentsActionImpl.java:90: warning: no @param for input
[WARNING] public static boolean isStringSafe(@CheckForNull String input, @CheckForNull EnvVars variables, @Nonnull Set<String> safeEnvVariables) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/actions/ArgumentsActionImpl.java:90: warning: no @param for variables
[WARNING] public static boolean isStringSafe(@CheckForNull String input, @CheckForNull EnvVars variables, @Nonnull Set<String> safeEnvVariables) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/actions/ArgumentsActionImpl.java:90: warning: no @param for safeEnvVariables
[WARNING] public static boolean isStringSafe(@CheckForNull String input, @CheckForNull EnvVars variables, @Nonnull Set<String> safeEnvVariables) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/actions/ArgumentsActionImpl.java:90: warning: no @return
[WARNING] public static boolean isStringSafe(@CheckForNull String input, @CheckForNull EnvVars variables, @Nonnull Set<String> safeEnvVariables) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/actions/ArgumentsActionImpl.java:79: warning: no @param for stepArguments
[WARNING] public ArgumentsActionImpl(@Nonnull Map<String, Object> stepArguments) {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/replay/ReplayAction.java:166: warning: no @return
[WARNING] /* accessible to Jelly */ public boolean isReplayableSandboxTest() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/replay/ReplayAction.java:179: warning: no @return
[WARNING] /* accessible to Jelly */ public String getOriginalScript() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/replay/ReplayAction.java:185: warning: no @return
[WARNING] /* accessible to Jelly */ public Map<String,String> getOriginalLoadedScripts() {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/replay/ReplayAction.java:276: warning: no @throws for java.io.IOException
[WARNING] public static @Nonnull Set<String> replacementsIn(@Nonnull CpsFlowExecution execution) throws IOException {
[WARNING] ^
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/replay/ReplayAction.java:298: warning: no @throws for java.io.IOException
[WARNING] public static @CheckForNull String replace(@Nonnull CpsFlowExecution execution, @Nonnull String clazz) throws IOException {
[WARNING] ^

to

[INFO] No previous run data found, generating javadoc.
[INFO] 
1 warning
[WARNING] Javadoc Warnings
[WARNING] …/workflow-cps-plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.java:773: warning: no description for @param
[WARNING] * @param programDataFile
[WARNING] ^

which looks like a genuine mistake.

timja
timja approved these changes Oct 2, 2020
View reviewed changes
Copy link
Member

@timja timja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice

oleg-nenashev
oleg-nenashev approved these changes Oct 2, 2020
View reviewed changes
Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 . It will definitely help

@jglick jglick merged commit 867284d into jenkinsci:master Oct 2, 2020
@jglick jglick deleted the doclint branch October 2, 2020 12:16
jglick added a commit to jglick/jenkins that referenced this pull request Oct 6, 2020
@jglick
Suppress some doclint as in jenkinsci/plugin-pom#356
7ff3ff5
@jglick jglick mentioned this pull request Oct 23, 2020
Closed
@jglick jglick mentioned this pull request Jun 27, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oleg-nenashev oleg-nenashev oleg-nenashev approved these changes

@timja timja timja approved these changes

Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jglick @oleg-nenashev @timja