Merge pull request #381 from MarkEWaite/fix-javadoc-warnings

Fix javadoc warnings
jenkinsci · May 7, 2024 · a584e94 · a584e94
2 parents f6fff3e + b4670a9
commit a584e94
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 7 deletions.
diff --git a/src/main/java/hudson/plugins/parameterizedtrigger/BuildInfoExporterAction.java b/src/main/java/hudson/plugins/parameterizedtrigger/BuildInfoExporterAction.java
@@ -243,7 +243,7 @@ private List<BuildReference> getBuildRefs(String project) {
      * Handle cases from older builds so that they still add old variables if
      * needed to. Should not show any UI as there will be no data added.
      *
-     * @return
+     * @return object extracted from old data
      */
     public Object readResolve() {
         if (this.lastReference == null) {
@@ -288,7 +288,7 @@ private String getBuildNumbersString(List<BuildReference> refs, String separator
     /**
      * Get a list of projects as a string using the separator
      *
-     * @param separator
+     * @param separator string to separate the list of projects
      * @return list of projects separated by separator
      */
     protected String getProjectListString(String separator) {

diff --git a/src/main/java/hudson/plugins/parameterizedtrigger/BuildTriggerConfig.java b/src/main/java/hudson/plugins/parameterizedtrigger/BuildTriggerConfig.java
@@ -848,8 +848,9 @@ public FormValidation doCheckProjects(@AncestorInPath Job<?, ?> project, @QueryP
          *
          * Copied from hudson.tasks.BuildTrigger.doAutoCompleteChildProjects(String value)
          *
-         * @param value
-         * @return
+         * @param value String provided by the user for autocompletion
+         * @param context Context of the autocompletion request
+         * @return candidates for autocompletion
          */
         public AutoCompletionCandidates doAutoCompleteProjects(
                 @QueryParameter String value, @AncestorInPath ItemGroup context) {

diff --git a/src/main/java/hudson/plugins/parameterizedtrigger/ParameterizedTriggerUtils.java b/src/main/java/hudson/plugins/parameterizedtrigger/ParameterizedTriggerUtils.java
@@ -44,7 +44,7 @@ public class ParameterizedTriggerUtils {
     /**
      * Load properties from string.
      *
-     * @throws IOException
+     * @throws IOException on IO error
      */
     public static Properties loadProperties(String properties) throws IOException {
         Properties p = new Properties();
@@ -58,7 +58,7 @@ public static Properties loadProperties(String properties) throws IOException {
      * @param f file to read
      * @param encoding null for platform default encoding.
      * @return read string
-     * @throws IOException
+     * @throws IOException on IO error
      */
     public static String readFileToString(FilePath f, String encoding) throws IOException, InterruptedException {
         try (InputStream in = f.read()) {
@@ -71,7 +71,7 @@ public static String readFileToString(FilePath f, String encoding) throws IOExce
      *
      * @param f file to read
      * @return read string
-     * @throws IOException
+     * @throws IOException on IO error
      */
     public static String readFileToString(VirtualFile f) throws IOException, InterruptedException {
         try (InputStream in = f.open()) {