[FIXED JENKINS-40827] Clarify the content of ObjectMetadataAction's g…

…etDescription() and getDisplayName()
jenkinsci · Jan 5, 2017 · 44a56e5 · 44a56e5
1 parent 8aa91ab
commit 44a56e5
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/src/main/java/jenkins/scm/api/metadata/ObjectMetadataAction.java b/src/main/java/jenkins/scm/api/metadata/ObjectMetadataAction.java
@@ -25,6 +25,7 @@
 package jenkins.scm.api.metadata;
 
 import edu.umd.cs.findbugs.annotations.CheckForNull;
+import hudson.Util;
 import hudson.model.InvisibleAction;
 import java.io.Serializable;
 import jenkins.scm.api.SCMHead;
@@ -77,7 +78,8 @@ public ObjectMetadataAction(@CheckForNull String objectDisplayName,
     }
 
     /**
-     * Returns the display name of the object or {@code null}.
+     * Returns the display name of the object or {@code null}. Consumers should assume the content is plain text that
+     * needs escaping with {@link Util#escape(String)} when being included in HTML output.
      *
      * @return the display name of the object or {@code null}
      */
@@ -89,9 +91,10 @@ public String getObjectDisplayName() {
     }
 
     /**
-     * Returns the description of the object or {@code null}.
+     * Returns the description of the object or {@code null}. Consumers should assume the content is plain text that
+     * needs escaping with {@link Util#escape(String)} when being included in HTML output.
      *
-     * @return the description of the object or {@code null}
+     * @return the description of the object or {@code null}.
      */
     @Exported
     @CheckForNull