Fix formatting and comments in AdministrativeMonitor.java

Author: LakshyaBagani

core/src/main/java/hudson/model/AdministrativeMonitor.java

@@ -57,41 +57,33 @@
  * monitoring and activate/deactivate the monitor accordingly. Sometimes
  * this can be done by updating a flag from code (see {@link SCMTrigger}
  * for one such example), while other times it's more convenient to do
- * so by running some code periodically (for this, use
- * {@link TimerTrigger#timer})
+ * so by running some code periodically (for this, use {@link TimerTrigger#timer})
  *
  * <p>
- * {@link AdministrativeMonitor}s are bound to URL by
- * {@link Jenkins#getAdministrativeMonitor(String)}.
+ * {@link AdministrativeMonitor}s are bound to URL by {@link Jenkins#getAdministrativeMonitor(String)}.
  * See {@link #getUrl()}.
  *
  * <h3>Views</h3>
  * <dl>
  * <dt>message.jelly</dt>
  * <dd>
- * If {@link #isActivated()} returns true, Jenkins will use the
- * {@code message.jelly}
+ * If {@link #isActivated()} returns true, Jenkins will use the {@code message.jelly}
  * view of this object to render the warning text. This happens in the
  * {@code http://SERVER/jenkins/manage} page. This view should typically render
  * a DIV box with class='alert alert-danger' or class='alert alert-warning' with
  * a human-readable text
  * inside it. It often also contains a link to a page that provides more details
  * about the problem.<br>
- * Additionally 2 numbers are shown in the Jenkins header of administrators, one
- * with the number or active
- * non-security relevant monitors and one with the number of active security
- * relevant monitors.
+ * Additionally 2 numbers are shown in the Jenkins header of administrators, one with the number or active
+ * non-security relevant monitors and one with the number of active security relevant monitors.
  * </dd>
  * </dl>
  *
  * <h3>Use with System Read permission</h3>
  * <p>
- * By default administrative monitors are visible only to users with Administer
- * permission.
- * Users with {@link Jenkins#SYSTEM_READ} permission can access administrative
- * monitors that override {@link #getRequiredPermission()}.
- * Care needs to be taken to ensure users with that permission don't have access
- * to actions modifying system state.
+ * By default administrative monitors are visible only to users with Administer permission.
+ * Users with {@link Jenkins#SYSTEM_READ} permission can access administrative monitors that override {@link #getRequiredPermission()}.
+ * Care needs to be taken to ensure users with that permission don't have access to actions modifying system state.
  * For more details, see {@link #getRequiredPermission()}.
  * </p>
  *
@@ -103,9 +95,7 @@ public abstract class AdministrativeMonitor extends AbstractModelObject implemen
     private static final Logger LOGGER = Logger.getLogger(AdministrativeMonitor.class.getName());
 
     /**
-     * Human-readable ID of this monitor, which needs to be unique within the
-     * system.
-     *
+     * Human-readable ID of this monitor, which needs to be unique within the system.
      * <p>
      * This ID is used to remember persisted setting for this monitor,
      * so the ID should remain consistent beyond the Hudson JVM lifespan.
@@ -154,13 +144,10 @@ public void disable(boolean value) throws IOException {
     }
 
     /**
-     * Returns true if this monitor {@link #disable(boolean) isn't disabled}
-     * earlier.
+     * Returns true if this monitor {@link #disable(boolean) isn't disabled} earlier.
      *
      * <p>
-     * This flag implements the ability for the admin to say "no thank you" to the
-     * monitor that
-     * he wants to ignore.
+     * This flag implements the ability for the admin to say "no thank you" to the monitor that he wants to ignore.
      */
     public boolean isEnabled() {
         if (isSnoozed()) {
@@ -309,21 +296,15 @@ public void doSnooze(StaplerRequest2 req, StaplerResponse2 rsp) throws IOExcepti
 
     /**
      * Required permission to view this admin monitor.
-     * By default {@link Jenkins#ADMINISTER}, but {@link Jenkins#SYSTEM_READ} or
-     * {@link Jenkins#MANAGE} are also supported.
+     * By default {@link Jenkins#ADMINISTER}, but {@link Jenkins#SYSTEM_READ} or {@link Jenkins#MANAGE} are also supported.
      * <p>
-     * Changing this permission check to return {@link Jenkins#SYSTEM_READ} will
-     * make the active
-     * administrative monitor appear on {@link ManageJenkinsAction} to users without
-     * Administer permission.
-     * {@link #doDisable(StaplerRequest2, StaplerResponse2)} will still always
-     * require Administer permission.
+     * Changing this permission check to return {@link Jenkins#SYSTEM_READ} will make the active
+     * administrative monitor appear on {@link ManageJenkinsAction} to users without Administer permission.
+     * {@link #doDisable(StaplerRequest2, StaplerResponse2)} will still always require Administer permission.
      * </p>
      * <p>
-     * This method only allows for a single permission to be returned. If more
-     * complex permission checks are required,
-     * override {@link #checkRequiredPermission()} and
-     * {@link #hasRequiredPermission()} instead.
+     * This method only allows for a single permission to be returned. If more complex permission checks are required,
+     * override {@link #checkRequiredPermission()} and {@link #hasRequiredPermission()} instead.
      * </p>
      * <p>
      * Implementers need to ensure that {@code doAct} and other web methods perform
@@ -336,23 +317,18 @@ public void doSnooze(StaplerRequest2 req, StaplerResponse2 rsp) throws IOExcepti
      * </p>
      *
      * @since 2.233
-     * @deprecated Callers should use {@link #checkRequiredPermission()} or
-     *             {@link #hasRequiredPermission()}.
+     * @deprecated Callers should use {@link #checkRequiredPermission()} or {@link #hasRequiredPermission()}.
      */
     @Deprecated
     public Permission getRequiredPermission() {
         return Jenkins.ADMINISTER;
     }
 
     /**
-     * Checks if the current user has the minimum required permission to view this
-     * administrative monitor.
+     * Checks if the current user has the minimum required permission to view this administrative monitor.
      * <p>
-     * Subclasses may override this method and {@link #hasRequiredPermission()}
-     * instead of {@link #getRequiredPermission()} to perform more complex
-     * permission checks,
-     * for example, checking either {@link Jenkins#MANAGE} or
-     * {@link Jenkins#SYSTEM_READ}.
+     * Subclasses may override this method and {@link #hasRequiredPermission()} instead of {@link #getRequiredPermission()} to perform more complex permission checks,
+     * for example, checking either {@link Jenkins#MANAGE} or {@link Jenkins#SYSTEM_READ}.
      * </p>
      *
      * @see #getRequiredPermission()
@@ -364,14 +340,10 @@ public void checkRequiredPermission() {
     }
 
     /**
-     * Checks if the current user has the minimum required permission to view this
-     * administrative monitor.
+     * Checks if the current user has the minimum required permission to view this administrative monitor.
      * <p>
-     * Subclasses may override this method and {@link #checkRequiredPermission}
-     * instead of {@link #getRequiredPermission()} to perform more complex
-     * permission checks,
-     * for example, checking either {@link Jenkins#MANAGE} or
-     * {@link Jenkins#SYSTEM_READ}.
+     * Subclasses may override this method and {@link #checkRequiredPermission} instead of {@link #getRequiredPermission()} to perform more complex permission checks,
+     * for example, checking either {@link Jenkins#MANAGE} or {@link Jenkins#SYSTEM_READ}.
      * </p>
      *
      * @see #getRequiredPermission()
@@ -383,11 +355,9 @@ public boolean hasRequiredPermission() {
     }
 
     /**
-     * Checks if the current user has the minimum required permission to view any
-     * administrative monitor.
+     * Checks if the current user has the minimum required permission to view any administrative monitor.
      *
-     * @return true if the current user has the minimum required permission to view
-     *         any administrative monitor.
+     * @return true if the current user has the minimum required permission to view any administrative monitor.
      *
      * @since 2.468
      */
@@ -396,8 +366,7 @@ public static boolean hasPermissionToDisplay() {
     }
 
     /**
-     * Ensure that URLs in this administrative monitor are only accessible to users
-     * with {@link #getRequiredPermission()}.
+     * Ensure that URLs in this administrative monitor are only accessible to users with {@link #getRequiredPermission()}.
      */
     @Override
     @Restricted(NoExternalUse.class)