From 680c54887ba9c847fcb992196dc375d5a7a86588 Mon Sep 17 00:00:00 2001
From: Dominique <dominiquebrice@users.noreply.github.com>
Date: Tue, 16 Sep 2014 21:12:59 -0400
Subject: [PATCH] Updating javadoc based on PR feedback

---
 core/src/main/java/hudson/Plugin.java                |  5 ++++-
 .../java/hudson/model/labels/LabelAtomProperty.java  | 12 +-----------
 .../model/labels/LabelAtomPropertyDescriptor.java    |  5 +++++
 3 files changed, 10 insertions(+), 12 deletions(-)

diff --git a/core/src/main/java/hudson/Plugin.java b/core/src/main/java/hudson/Plugin.java
index 0c08ecb35b..e2a061fbda 100644
--- a/core/src/main/java/hudson/Plugin.java
+++ b/core/src/main/java/hudson/Plugin.java
@@ -48,7 +48,10 @@ import com.thoughtworks.xstream.XStream;
  * Base class of Hudson plugin.
  *
  * <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>
  * One instance of a plugin is created by Hudson, and used as the entry point
diff --git a/core/src/main/java/hudson/model/labels/LabelAtomProperty.java b/core/src/main/java/hudson/model/labels/LabelAtomProperty.java
index 41a1d7189b..efaad2ab77 100644
--- a/core/src/main/java/hudson/model/labels/LabelAtomProperty.java
+++ b/core/src/main/java/hudson/model/labels/LabelAtomProperty.java
@@ -40,19 +40,9 @@ import java.util.Collections;
  * 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
  * 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
+ * @see hudson.model.labels.LabelAtomPropertyDescriptor
  * @since 1.373
  */
 @ExportedBean
diff --git a/core/src/main/java/hudson/model/labels/LabelAtomPropertyDescriptor.java b/core/src/main/java/hudson/model/labels/LabelAtomPropertyDescriptor.java
index 43724c73c4..82312097dc 100644
--- a/core/src/main/java/hudson/model/labels/LabelAtomPropertyDescriptor.java
+++ b/core/src/main/java/hudson/model/labels/LabelAtomPropertyDescriptor.java
@@ -31,6 +31,11 @@ import hudson.model.Descriptor;
  *
  * <p>
  * 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
  * @since 1.373
-- 
GitLab