diff --git a/core/src/main/java/hudson/model/Descriptor.java b/core/src/main/java/hudson/model/Descriptor.java index 65628b21f64bbfa8ee68419c481c87585878edc7..52c6b90ae77a022d35c15b5b3ce621cd42db19c6 100644 --- a/core/src/main/java/hudson/model/Descriptor.java +++ b/core/src/main/java/hudson/model/Descriptor.java @@ -101,6 +101,15 @@ public abstract class Descriptor> { /** * Returns the resource path to the help screen HTML, if any. + * + *

+ * This value is relative to the context root of Hudson, so normally + * the values are something like "/plugin/emma/help.html" to + * refer to static resource files in a plugin, or "/publisher/EmmaPublisher/abc" + * to refer to Jelly script abc.jelly or a method EmmaPublisher.doAbc(). + * + * @return + * "" to indicate that there's no help. */ public String getHelpFile() { return "";