Skip to content

Commit fa9817c

Browse files
committed
Revert Javadoc formatting changes to match original style
1 parent 3254ab7 commit fa9817c

File tree

1 file changed

+21
-43
lines changed

1 file changed

+21
-43
lines changed

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

Lines changed: 21 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -57,30 +57,24 @@
5757
* monitoring and activate/deactivate the monitor accordingly. Sometimes
5858
* this can be done by updating a flag from code (see {@link SCMTrigger}
5959
* for one such example), while other times it's more convenient to do
60-
* so by running some code periodically (for this, use
61-
* {@link TimerTrigger#timer})
60+
* so by running some code periodically (for this, use {@link TimerTrigger#timer})
6261
*
6362
* <p>
64-
* {@link AdministrativeMonitor}s are bound to URL by
65-
* {@link Jenkins#getAdministrativeMonitor(String)}.
63+
* {@link AdministrativeMonitor}s are bound to URL by {@link Jenkins#getAdministrativeMonitor(String)}.
6664
* See {@link #getUrl()}.
6765
*
6866
* <h3>Views</h3>
6967
* <dl>
7068
* <dt>message.jelly</dt>
7169
* <dd>
72-
* If {@link #isActivated()} returns true, Jenkins will use the
73-
* {@code message.jelly}
70+
* If {@link #isActivated()} returns true, Jenkins will use the {@code message.jelly}
7471
* view of this object to render the warning text. This happens in the
7572
* {@code http://SERVER/jenkins/manage} page. This view should typically render
76-
* a DIV box with class='alert alert-danger' or class='alert alert-warning' with
77-
* a human-readable text
73+
* a DIV box with class='alert alert-danger' or class='alert alert-warning' with a human-readable text
7874
* inside it. It often also contains a link to a page that provides more details
7975
* about the problem.<br>
80-
* Additionally 2 numbers are shown in the Jenkins header of administrators, one
81-
* with the number or active
82-
* non-security relevant monitors and one with the number of active security
83-
* relevant monitors.
76+
* Additionally 2 numbers are shown in the Jenkins header of administrators, one with the number or active
77+
* non-security relevant monitors and one with the number of active security relevant monitors.
8478
* </dd>
8579
* </dl>
8680
*
@@ -103,8 +97,7 @@ public abstract class AdministrativeMonitor extends AbstractModelObject implemen
10397
private static final Logger LOGGER = Logger.getLogger(AdministrativeMonitor.class.getName());
10498

10599
/**
106-
* Human-readable ID of this monitor, which needs to be unique within the
107-
* system.
100+
* Human-readable ID of this monitor, which needs to be unique within the system.
108101
*
109102
* <p>
110103
* This ID is used to remember persisted setting for this monitor,
@@ -121,8 +114,7 @@ protected AdministrativeMonitor() {
121114
}
122115

123116
/**
124-
* Returns the URL of this monitor, relative to the context path, like
125-
* "administrativeMonitor/foobar".
117+
* Returns the URL of this monitor, relative to the context path, like "administrativeMonitor/foobar".
126118
*/
127119
public String getUrl() {
128120
return "administrativeMonitor/" + id;
@@ -154,13 +146,11 @@ public void disable(boolean value) throws IOException {
154146
}
155147

156148
/**
157-
* Returns true if this monitor {@link #disable(boolean) isn't disabled}
158-
* earlier.
149+
* Returns true if this monitor {@link #disable(boolean) isn't disabled} earlier.
159150
*
160151
* <p>
161-
* This flag implements the ability for the admin to say "no thank you" to the
162-
* monitor that
163-
* he wants to ignore.
152+
* This flag implements the ability for the admin to say "no thank you" to the monitor that
153+
* he wants to ignore.
164154
*/
165155
public boolean isEnabled() {
166156
if (isSnoozed()) {
@@ -215,8 +205,7 @@ public void snooze(long durationMs) throws IOException {
215205
}
216206

217207
/**
218-
* Returns true if this monitor is activated and
219-
* wants to produce a warning message.
208+
* Returns true if this monitor is activated and wants to produce a warning message.
220209
*
221210
* <p>
222211
* This method is called from the HTML rendering thread,
@@ -288,8 +277,7 @@ public void doSnooze(StaplerRequest2 req, StaplerResponse2 rsp) throws IOExcepti
288277

289278
/**
290279
* Required permission to view this admin monitor.
291-
* By default {@link Jenkins#ADMINISTER}, but {@link Jenkins#SYSTEM_READ} or
292-
* {@link Jenkins#MANAGE} are also supported.
280+
* By default {@link Jenkins#ADMINISTER}, but {@link Jenkins#SYSTEM_READ} or {@link Jenkins#MANAGE} are also supported.
293281
* <p>
294282
* Changing this permission check to return {@link Jenkins#SYSTEM_READ} will
295283
* make the active
@@ -315,8 +303,7 @@ public void doSnooze(StaplerRequest2 req, StaplerResponse2 rsp) throws IOExcepti
315303
* </p>
316304
*
317305
* @since 2.233
318-
* @deprecated Callers should use {@link #checkRequiredPermission()} or
319-
* {@link #hasRequiredPermission()}.
306+
* @deprecated Callers should use {@link #checkRequiredPermission()} or {@link #hasRequiredPermission()}.
320307
*/
321308
@Deprecated
322309
public Permission getRequiredPermission() {
@@ -327,11 +314,8 @@ public Permission getRequiredPermission() {
327314
* Checks if the current user has the minimum required permission to view this
328315
* administrative monitor.
329316
* <p>
330-
* Subclasses may override this method and {@link #hasRequiredPermission()}
331-
* instead of {@link #getRequiredPermission()} to perform more complex
332-
* permission checks,
333-
* for example, checking either {@link Jenkins#MANAGE} or
334-
* {@link Jenkins#SYSTEM_READ}.
317+
* Subclasses may override this method and {@link #hasRequiredPermission()} instead of {@link #getRequiredPermission()} to perform more complex permission checks,
318+
* for example, checking either {@link Jenkins#MANAGE} or {@link Jenkins#SYSTEM_READ}.
335319
* </p>
336320
*
337321
* @see #getRequiredPermission()
@@ -346,11 +330,8 @@ public void checkRequiredPermission() {
346330
* Checks if the current user has the minimum required permission to view this
347331
* administrative monitor.
348332
* <p>
349-
* Subclasses may override this method and {@link #checkRequiredPermission}
350-
* instead of {@link #getRequiredPermission()} to perform more complex
351-
* permission checks,
352-
* for example, checking either {@link Jenkins#MANAGE} or
353-
* {@link Jenkins#SYSTEM_READ}.
333+
* Subclasses may override this method and {@link #checkRequiredPermission} instead of {@link #getRequiredPermission()} to perform more complex permission checks,
334+
* for example, checking either {@link Jenkins#MANAGE} or {@link Jenkins#SYSTEM_READ}.
354335
* </p>
355336
*
356337
* @see #getRequiredPermission()
@@ -362,11 +343,9 @@ public boolean hasRequiredPermission() {
362343
}
363344

364345
/**
365-
* Checks if the current user has the minimum required permission to view any
366-
* administrative monitor.
346+
* Checks if the current user has the minimum required permission to view any administrative monitor.
367347
*
368-
* @return true if the current user has the minimum required permission to view
369-
* any administrative monitor.
348+
* @return true if the current user has the minimum required permission to view any administrative monitor.
370349
*
371350
* @since 2.468
372351
*/
@@ -375,8 +354,7 @@ public static boolean hasPermissionToDisplay() {
375354
}
376355

377356
/**
378-
* Ensure that URLs in this administrative monitor are only accessible to users
379-
* with {@link #getRequiredPermission()}.
357+
* Ensure that URLs in this administrative monitor are only accessible to users with {@link #getRequiredPermission()}.
380358
*/
381359
@Override
382360
@Restricted(NoExternalUse.class)

0 commit comments

Comments
 (0)