提交 680c5488 编写于 作者: D Dominique

Updating javadoc based on PR feedback

上级 259f5e17
...@@ -48,7 +48,10 @@ import com.thoughtworks.xstream.XStream; ...@@ -48,7 +48,10 @@ import com.thoughtworks.xstream.XStream;
* Base class of Hudson plugin. * Base class of Hudson plugin.
* *
* <p> * <p>
* A plugin may derive from this class. * A plugin may derive from this class, or it may directly define extension
* points annotated with {@link hudson.Extension}. For a list of extension
* points, see <a href="https://wiki.jenkins-ci.org/display/JENKINS/Extension+points">
* https://wiki.jenkins-ci.org/display/JENKINS/Extension+points</a>.
* *
* <p> * <p>
* One instance of a plugin is created by Hudson, and used as the entry point * One instance of a plugin is created by Hudson, and used as the entry point
......
...@@ -40,19 +40,9 @@ import java.util.Collections; ...@@ -40,19 +40,9 @@ import java.util.Collections;
* Plugins can contribute this extension point to add additional data or UI actions to {@link LabelAtom}. * Plugins can contribute this extension point to add additional data or UI actions to {@link LabelAtom}.
* {@link LabelAtomProperty}s show up in the configuration screen of a label, and they are persisted * {@link LabelAtomProperty}s show up in the configuration screen of a label, and they are persisted
* with the {@link LabelAtom} object. * with the {@link LabelAtom} object.
*
* <h2>Implementation hints</h2>
* <ul>
* <li>extend this class and define a static inner class extending {@link hudson.model.labels.LabelAtomPropertyDescriptor}</li>
* <li>in the inner class override <code>getDisplayName()</code>. This function returns the name of the option shown in the label
* configuration page to activate your extension</li>
* <li>if you need additional parameters in this page when activating your extension, provide a <tt>config.jelly</tt> file</li>
* <li>when the user saves the label configuration page with your extension activated, Jenkins calls the corresponding
* {@link org.kohsuke.stapler.DataBoundConstructor}-annotated constructor in your LabelAtomProperty subclass</li>
* <li>override the <code>getActions()</code> function to return your additional {@link hudson.model.Action}(s)</li>
* </ul>
* *
* @author Kohsuke Kawaguchi * @author Kohsuke Kawaguchi
* @see hudson.model.labels.LabelAtomPropertyDescriptor
* @since 1.373 * @since 1.373
*/ */
@ExportedBean @ExportedBean
......
...@@ -31,6 +31,11 @@ import hudson.model.Descriptor; ...@@ -31,6 +31,11 @@ import hudson.model.Descriptor;
* *
* <p> * <p>
* Put {@link Extension} on your descriptor implementation to have it auto-registered. * Put {@link Extension} on your descriptor implementation to have it auto-registered.
*
* <p>
* When extending this class, override <code>Descriptor.getDisplayName()</code>. In the
* context of LabelAtomPropertyDescriptor, this function is used to determine the label of
* the checkbox shown in the label's configuration page to activate the extension.
* *
* @author Kohsuke Kawaguchi * @author Kohsuke Kawaguchi
* @since 1.373 * @since 1.373
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册