From b18f736789fd145fa8cdf7c0717c1f37d6ddddee Mon Sep 17 00:00:00 2001 From: Jesse Glick Date: Thu, 22 Jan 2015 07:25:48 -0500 Subject: [PATCH] Better Javadoc. --- core/src/main/java/hudson/scm/SCM.java | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/core/src/main/java/hudson/scm/SCM.java b/core/src/main/java/hudson/scm/SCM.java index 4994febe4b..297ec0e2e1 100644 --- a/core/src/main/java/hudson/scm/SCM.java +++ b/core/src/main/java/hudson/scm/SCM.java @@ -700,7 +700,10 @@ public abstract class SCM implements Describable, ExtensionPoint { } /** - * Returns the list of {@link SCMDescriptor}s that are applicable to the given project. + * Determines which kinds of SCMs are applicable to a given project. + * @param project a project on which we might be configuring SCM, or null if unknown + * @return all descriptors which {@link SCMDescriptor#isApplicable(Job)} to it, also filtered by {@link TopLevelItemDescriptor#isApplicable}; + * or simply {@link #all} if there is no project * @since 1.568 */ public static List> _for(@CheckForNull final Job project) {