[JENKINS-31162] More context in a javadoc

jenkinsci · Mar 21, 2016 · 4bdadc2 · 4bdadc2
1 parent ad2ae9d
commit 4bdadc2
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/core/src/main/java/hudson/model/TopLevelItemDescriptor.java b/core/src/main/java/hudson/model/TopLevelItemDescriptor.java
@@ -180,6 +180,9 @@ public String getCategoryId() {
     /**
      * Represents a file path pattern to get the Item icon in different sizes.
      *
+     * For example: plugin/plugin-shortname/images/:size/item.png, where {@code :size} represents the different
+     * icon sizes used commonly in Jenkins project: 16x16, 24x24, 32x32 or 48x48
+     *
      * @return A string or null if it is not defined.
      *
      * @since TODO