Skip to content
Permalink
Browse files
[FIXED JENKINS-40827] Clarify the content of ObjectMetadataAction's g…
…etDescription() and getDisplayName()
  • Loading branch information
stephenc committed Jan 5, 2017
1 parent 8aa91ab commit 44a56e5a54582d2ca75125feeb8bdc205cfd82d2
Showing with 6 additions and 3 deletions.
  1. +6 −3 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

0 comments on commit 44a56e5

Please sign in to comment.