[JENKINS-31162] Some javadoc were reviewed

jenkinsci · Mar 14, 2016 · ac72888 · ac72888
1 parent 4ce1085
commit ac72888
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 7 deletions.
diff --git a/core/src/main/java/hudson/model/View.java b/core/src/main/java/hudson/model/View.java
@@ -1002,9 +1002,11 @@ public synchronized void doDoDelete(StaplerRequest req, StaplerResponse rsp) thr
     public abstract Item doCreateItem( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException;
 
     /**
-     * A new API method to get the allowed {$link TopLevelItem}s and its categories.
+     * An API method to get the allowed {$link TopLevelItem}s and its categories.
      *
-     * @return A {$Categories} entity that is shown as  JSON file.
+     * @return A {@link Categories} entity that is shown as  JSON file.
+     *
+     * @since TODO
      */
     public Categories doCategories(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
         return ItemGroupMixIn.getCategories(Jenkins.getAuthentication(), Jenkins.getInstance());

diff --git a/core/src/main/java/jenkins/model/item_category/Categories.java b/core/src/main/java/jenkins/model/item_category/Categories.java
@@ -16,7 +16,9 @@
 import java.util.List;
 
 /**
- * It is a logic representation of a set of {$Category}.
+ * It is a logic representation of a set of {@link Category}.
+ *
+ * This class is not thread-safe.
  */
 @ExportedBean
 public class Categories implements HttpResponse, Serializable {

diff --git a/core/src/main/java/jenkins/model/item_category/Category.java b/core/src/main/java/jenkins/model/item_category/Category.java
@@ -9,7 +9,9 @@
 import java.util.Map;
 
 /**
- * Represents an {$link item_category} and its {@link TopLevelItem}s.
+ * Represents an {@link ItemCategory} and its {@link TopLevelItem}s.
+ *
+ * This class is not thread-safe.
  */
 @ExportedBean
 public class Category implements Serializable {

diff --git a/core/src/main/java/jenkins/model/item_category/ItemCategory.java b/core/src/main/java/jenkins/model/item_category/ItemCategory.java
@@ -7,6 +7,8 @@
 
 /**
  * A category for {@link hudson.model.Item}s.
+ *
+ * @since TODO
  */
 public abstract class ItemCategory implements ModelObject, ExtensionPoint {
 
@@ -50,7 +52,7 @@ public abstract class ItemCategory implements ModelObject, ExtensionPoint {
     public abstract int getMinToShow();
 
     /**
-     * The default category, if an item doesn't belong anywhere else, this is where it goes by default.
+     * The default {@link ItemCategory}, if an item doesn't belong anywhere else, this is where it goes by default.
      */
     @Extension
     public static final class Default extends ItemCategory {

diff --git a/core/src/main/java/jenkins/model/item_category/ItemCategoryConfigurator.java b/core/src/main/java/jenkins/model/item_category/ItemCategoryConfigurator.java
@@ -11,6 +11,8 @@
 
 /**
  * A mapper of {@link ItemCategory}s to {@link hudson.model.Item}s.
+ *
+ * @since TODO
  */
 public abstract class ItemCategoryConfigurator implements ExtensionPoint {
 
@@ -19,7 +21,7 @@ public abstract class ItemCategoryConfigurator implements ExtensionPoint {
      *
      * @param descriptor the item to categorize
      *
-     * @return the category or null
+     * @return A {@link ItemCategory} or null
      */
     @CheckForNull
     protected abstract ItemCategory getCategoryFor(@Nonnull TopLevelItemDescriptor descriptor);
@@ -30,7 +32,7 @@ public abstract class ItemCategoryConfigurator implements ExtensionPoint {
      *
      * @param descriptor the item to categorize.
      *
-     * @return the category
+     * @return A {@link ItemCategory}
      */
     @Nonnull
     public static ItemCategory getCategory(@Nonnull TopLevelItemDescriptor descriptor) {