From 7c16d8dc46ff1d0226ca674d1f16d5d252905df6 Mon Sep 17 00:00:00 2001 From: Jesse Glick Date: Tue, 11 Apr 2017 09:26:45 -0400 Subject: [PATCH] Fix Javadoc generation on JDK 8. --- Jenkinsfile | 2 +- .../java/hudson/cli/FullDuplexHttpStream.java | 2 +- .../main/java/hudson/AbstractMarkupText.java | 4 +-- .../java/hudson/ClassicPluginStrategy.java | 2 +- .../main/java/hudson/ExtensionListView.java | 1 + core/src/main/java/hudson/FilePath.java | 8 +++--- .../java/hudson/FileSystemProvisioner.java | 2 +- core/src/main/java/hudson/Functions.java | 6 ++--- core/src/main/java/hudson/MarkupText.java | 6 ++--- core/src/main/java/hudson/Platform.java | 2 +- core/src/main/java/hudson/Plugin.java | 4 +-- core/src/main/java/hudson/Proc.java | 2 +- .../java/hudson/diagnosis/OldDataMonitor.java | 2 +- .../diagnosis/ReverseProxySetupMonitor.java | 2 +- .../main/java/hudson/model/AbstractBuild.java | 4 +-- .../main/java/hudson/model/AbstractItem.java | 2 +- core/src/main/java/hudson/model/Action.java | 14 +++++----- .../hudson/model/AdministrativeMonitor.java | 1 + core/src/main/java/hudson/model/Build.java | 2 +- core/src/main/java/hudson/model/Computer.java | 3 ++- .../main/java/hudson/model/Descriptor.java | 2 +- .../hudson/model/EnvironmentContributor.java | 5 ++-- core/src/main/java/hudson/model/Executor.java | 2 +- .../java/hudson/model/ExecutorListener.java | 1 + .../main/java/hudson/model/HealthReport.java | 6 ++--- .../src/main/java/hudson/model/ItemGroup.java | 1 + .../java/hudson/model/ItemGroupMixIn.java | 2 +- core/src/main/java/hudson/model/Job.java | 2 +- .../hudson/model/JobPropertyDescriptor.java | 4 +-- core/src/main/java/hudson/model/Label.java | 12 ++++----- .../main/java/hudson/model/PageDecorator.java | 22 +++++++--------- .../hudson/model/ParameterDefinition.java | 7 +++-- .../java/hudson/model/ParameterValue.java | 8 +++--- .../main/java/hudson/model/PeriodicWork.java | 1 + core/src/main/java/hudson/model/Queue.java | 6 ++--- core/src/main/java/hudson/model/Run.java | 10 +++---- core/src/main/java/hudson/model/RunMap.java | 1 + core/src/main/java/hudson/model/Saveable.java | 1 + .../hudson/model/TopLevelItemDescriptor.java | 2 +- core/src/main/java/hudson/model/User.java | 2 +- core/src/main/java/hudson/model/View.java | 4 +-- .../java/hudson/model/ViewDescriptor.java | 2 +- .../java/hudson/model/ViewGroupMixIn.java | 9 ++++--- .../hudson/model/listeners/RunListener.java | 2 +- .../hudson/model/listeners/SCMListener.java | 2 +- .../java/hudson/model/queue/Executables.java | 2 +- .../hudson/model/queue/QueueListener.java | 1 + .../org/apache/tools/tar/TarOutputStream.java | 2 +- .../main/java/hudson/scheduler/CronTab.java | 2 +- core/src/main/java/hudson/scm/SCM.java | 10 +++---- .../security/BasicAuthenticationFilter.java | 6 ++--- .../java/hudson/security/PermissionAdder.java | 1 + .../java/hudson/security/SecurityRealm.java | 7 +++-- .../src/main/java/hudson/security/SidACL.java | 2 +- core/src/main/java/hudson/slaves/Cloud.java | 8 +++--- .../slaves/CloudProvisioningListener.java | 3 ++- .../src/main/java/hudson/tasks/BuildStep.java | 3 ++- core/src/main/java/hudson/tasks/Maven.java | 2 +- .../main/java/hudson/tools/JDKInstaller.java | 4 +-- .../main/java/hudson/triggers/SCMTrigger.java | 2 +- .../java/hudson/triggers/SafeTimerTask.java | 1 + .../java/hudson/util/ArgumentListBuilder.java | 26 +++++++++---------- .../java/hudson/util/ChunkedOutputStream.java | 2 +- .../java/hudson/util/CyclicGraphDetector.java | 2 +- .../java/hudson/util/DescribableList.java | 2 +- core/src/main/java/hudson/util/FormApply.java | 2 +- .../java/hudson/util/FormFieldValidator.java | 2 +- .../main/java/hudson/util/HttpResponses.java | 2 +- .../main/java/hudson/util/ListBoxModel.java | 12 ++++----- core/src/main/java/hudson/util/Memoizer.java | 2 +- .../java/hudson/util/NamingThreadFactory.java | 1 + .../java/hudson/util/QueryParameterMap.java | 2 +- .../java/hudson/util/jna/GNUCLibrary.java | 1 + .../java/hudson/util/spring/BeanBuilder.java | 8 +++--- .../hudson/util/spring/ClosureScript.java | 2 +- .../java/hudson/views/ListViewColumn.java | 2 +- .../java/hudson/widgets/HistoryWidget.java | 2 +- core/src/main/java/hudson/widgets/Widget.java | 4 +-- .../src/main/java/jenkins/FilePathFilter.java | 2 +- .../java/jenkins/model/ArtifactManager.java | 3 ++- .../java/jenkins/model/BuildDiscarder.java | 1 + .../jenkins/model/DependencyDeclarer.java | 1 + .../DirectlyModifiableTopLevelItemGroup.java | 2 ++ .../java/jenkins/model/FingerprintFacet.java | 3 +-- .../main/java/jenkins/model/IdStrategy.java | 2 +- core/src/main/java/jenkins/model/Jenkins.java | 3 ++- .../model/ModelObjectWithContextMenu.java | 4 +-- .../java/jenkins/model/PeepholePermalink.java | 2 +- .../java/jenkins/model/RunIdMigrator.java | 6 ++--- .../model/lazy/AbstractLazyLoadRunMap.java | 4 +-- .../model/queue/AsynchronousExecution.java | 4 +++ .../security/BasicHeaderProcessor.java | 1 - .../jenkins/security/ConfidentialKey.java | 1 + .../jenkins/security/ConfidentialStore.java | 2 ++ .../security/UpdateSiteWarningsMonitor.java | 2 +- .../jenkins/security/s2m/package-info.java | 2 +- .../java/jenkins/tasks/SimpleBuildStep.java | 6 +++++ .../jenkins/tasks/SimpleBuildWrapper.java | 1 + .../java/jenkins/util/SystemProperties.java | 2 +- .../main/java/jenkins/util/VirtualFile.java | 1 - .../jenkins/util/groovy/GroovyHookScript.java | 2 +- .../java/jenkins/util/xstream/XStreamDOM.java | 16 ++++++------ pom.xml | 5 +--- test/pom.xml | 6 +++++ 104 files changed, 213 insertions(+), 188 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index d7cc19de84..266bf5ce46 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -44,7 +44,7 @@ for(i = 0; i < buildTypes.size(); i++) { // The -Dmaven.repo.local=${pwd()}/.repository means that Maven will create a // .repository directory at the root of the build (which it gets from the // pwd() Workflow call) and use that for the local Maven repository. - def mvnCmd = "mvn -Pdebug -U clean install ${runTests ? '-Dmaven.test.failure.ignore=true' : '-DskipTests'} -V -B -Dmaven.repo.local=${pwd()}/.repository" + def mvnCmd = "mvn -Pdebug -U clean install javadoc:javadoc ${runTests ? '-Dmaven.test.failure.ignore=true' : '-DskipTests'} -V -B -Dmaven.repo.local=${pwd()}/.repository" if(isUnix()) { sh mvnCmd } else { diff --git a/cli/src/main/java/hudson/cli/FullDuplexHttpStream.java b/cli/src/main/java/hudson/cli/FullDuplexHttpStream.java index c01f3261ce..8017b44e41 100644 --- a/cli/src/main/java/hudson/cli/FullDuplexHttpStream.java +++ b/cli/src/main/java/hudson/cli/FullDuplexHttpStream.java @@ -61,7 +61,7 @@ public class FullDuplexHttpStream { /** * @param base the base URL of Jenkins - * @param target + * @param relativeTarget * The endpoint that we are making requests to. * @param authorization * The value of the authorization header, if non-null. diff --git a/core/src/main/java/hudson/AbstractMarkupText.java b/core/src/main/java/hudson/AbstractMarkupText.java index ed7e319711..1e78b3e10c 100644 --- a/core/src/main/java/hudson/AbstractMarkupText.java +++ b/core/src/main/java/hudson/AbstractMarkupText.java @@ -72,8 +72,8 @@ public abstract class AbstractMarkupText { * Adds a start tag and end tag at the specified position. * *

- * For example, if the text was "abc", then addMarkup(1,2,"<b>","</b>") - * would generate "a<b>b</b>c" + * For example, if the text was "abc", then {@code addMarkup(1,2,"","")} + * would generate {@code"abc"} */ public abstract void addMarkup( int startPos, int endPos, String startTag, String endTag ); diff --git a/core/src/main/java/hudson/ClassicPluginStrategy.java b/core/src/main/java/hudson/ClassicPluginStrategy.java index 17722cef44..2744f537e6 100644 --- a/core/src/main/java/hudson/ClassicPluginStrategy.java +++ b/core/src/main/java/hudson/ClassicPluginStrategy.java @@ -392,7 +392,7 @@ public class ClassicPluginStrategy implements PluginStrategy { * Gets the minimum required version for the current version of Jenkins. * * @return the minimum required version for the current version of Jenkins. - * @sice 2.16 + * @since 2.16 */ public VersionNumber getRequiredVersion() { return new VersionNumber(requiredVersion); diff --git a/core/src/main/java/hudson/ExtensionListView.java b/core/src/main/java/hudson/ExtensionListView.java index 59b81ffd95..100dad6fb7 100644 --- a/core/src/main/java/hudson/ExtensionListView.java +++ b/core/src/main/java/hudson/ExtensionListView.java @@ -23,6 +23,7 @@ */ package hudson; +import hudson.tasks.UserNameResolver; import jenkins.model.Jenkins; import hudson.util.CopyOnWriteList; diff --git a/core/src/main/java/hudson/FilePath.java b/core/src/main/java/hudson/FilePath.java index 445a4086a0..985bf56e33 100644 --- a/core/src/main/java/hudson/FilePath.java +++ b/core/src/main/java/hudson/FilePath.java @@ -167,7 +167,7 @@ import static hudson.Util.isSymlink; * } * // if 'file' is on a different node, this FileCallable will * // be transferred to that node and executed there. - * private static final class Freshen implements FileCallable<Void> { + * private static final class Freshen implements FileCallable<Void> { * private static final long serialVersionUID = 1; * @Override public Void invoke(File f, VirtualChannel channel) { * // f and file represent the same thing @@ -933,7 +933,7 @@ public final class FilePath implements Serializable { /** * Code that gets executed on the machine where the {@link FilePath} is local. * Used to act on {@link FilePath}. - * Warning: implementations must be serializable, so prefer a static nested class to an inner class. + * Warning: implementations must be serializable, so prefer a static nested class to an inner class. * *

* Subtypes would likely want to extend from either {@link MasterToSlaveCallable} @@ -2314,7 +2314,7 @@ public final class FilePath implements Serializable { } /** - * Same as {@link #validateFileMask(String, int, boolean)} with caseSensitive set to true + * Same as {@link #validateAntFileMask(String, int, boolean)} with caseSensitive set to true */ public String validateAntFileMask(final String fileMasks, final int bound) throws IOException, InterruptedException { return validateAntFileMask(fileMasks, bound, true); @@ -2523,7 +2523,7 @@ public final class FilePath implements Serializable { } /** - * Shortcut for {@link #validateFileMask(String,true,boolean)} as the left-hand side can be null. + * Shortcut for {@link #validateFileMask(String,boolean,boolean)} with {@code errorIfNotExist} true, as the left-hand side can be null. */ public static FormValidation validateFileMask(@CheckForNull FilePath path, String value, boolean caseSensitive) throws IOException { if(path==null) return FormValidation.ok(); diff --git a/core/src/main/java/hudson/FileSystemProvisioner.java b/core/src/main/java/hudson/FileSystemProvisioner.java index 42d2b6ca53..5b13241fbe 100644 --- a/core/src/main/java/hudson/FileSystemProvisioner.java +++ b/core/src/main/java/hudson/FileSystemProvisioner.java @@ -53,7 +53,7 @@ import java.io.OutputStream; * STILL A WORK IN PROGRESS. SUBJECT TO CHANGE! DO NOT EXTEND. * * TODO: is this per {@link Computer}? Per {@link Job}? - * -> probably per agent. + * → probably per agent. * *

Design Problems

*
    diff --git a/core/src/main/java/hudson/Functions.java b/core/src/main/java/hudson/Functions.java index 9ff620a894..c63c6dbb14 100644 --- a/core/src/main/java/hudson/Functions.java +++ b/core/src/main/java/hudson/Functions.java @@ -1798,7 +1798,7 @@ public class Functions { } /** - * Generate a series of <script> tags to include script.js + * Generate a series of {@code