[JENKINS-45814] Fix javadoc to reflect intended purpose of class

jenkinsci · Jul 27, 2017 · 22c8d12 · 22c8d12
1 parent e4399aa
commit 22c8d12
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/main/java/jenkins/branch/NoTriggerBranchProperty.java b/src/main/java/jenkins/branch/NoTriggerBranchProperty.java
@@ -37,7 +37,9 @@
 import org.kohsuke.stapler.DataBoundConstructor;
 
 /**
- * Suppresses builds due to {@link BranchIndexingCause}.
+ * Suppresses builds due to either {@link BranchIndexingCause} or {@link BranchEventCause}.
+ * The purpose of this property is to prevent triggering builds resulting from the <em>detection</em>
+ * of changes in the underlying SCM.
  */
 @Restricted(NoExternalUse.class)
 public class NoTriggerBranchProperty extends BranchProperty {