Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[FIXED JENKINS-40827] Clarify the content of ObjectMetadataAction's getDescription() and getDisplayName() #21

Merged
merged 1 commit into from
Jan 6, 2017
Merged

[FIXED JENKINS-40827] Clarify the content of ObjectMetadataAction's getDescription() and getDisplayName() #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 6 additions & 3 deletions src/main/java/jenkins/scm/api/metadata/ObjectMetadataAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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}
*/
Expand All @@ -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
Expand Down