Javadoc and @SInCE as applicable

jenkinsci · Oct 15, 2024 · 168ffeb · 168ffeb
1 parent 3a6d79c
commit 168ffeb
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/core/src/main/java/hudson/model/Computer.java b/core/src/main/java/hudson/model/Computer.java
@@ -704,6 +704,7 @@ public void setTemporarilyOffline(boolean temporarilyOffline, OfflineCause cause
      *
      * @param temporaryOfflineCause The reason why the node is being put offline.
      *                                If null, this cancels the status
+     * @since TODO
      */
     public void setTemporaryOfflineCause(@CheckForNull OfflineCause temporaryOfflineCause) {
         var node = getNode();
@@ -713,6 +714,10 @@ public void setTemporaryOfflineCause(@CheckForNull OfflineCause temporaryOffline
         node.setTemporaryOfflineCause(temporaryOfflineCause);
     }
 
+    /**
+     * @since TODO
+     * @return If the node is temporarily offline, the reason why.
+     */
     @SuppressWarnings("unused") // used by setOfflineCause.jelly
     public String getTemporaryOfflineCauseReason() {
         var node = getNode();

diff --git a/core/src/main/java/hudson/model/Node.java b/core/src/main/java/hudson/model/Node.java
@@ -264,6 +264,9 @@ public void onLoad(Nodes parent, String name) {
         setNodeName(name);
     }
 
+    /**
+     * @return true if this node has a temporary offline cause set.
+     */
     boolean isTemporarilyOffline() {
         return temporaryOfflineCause != null;
     }

diff --git a/core/src/main/java/hudson/slaves/OfflineCause.java b/core/src/main/java/hudson/slaves/OfflineCause.java
@@ -170,6 +170,9 @@ public User getUser() {
             ;
         }
 
+        /**
+         * @return the message that was provided when the computer was taken offline
+         */
         public String getMessage() {
             return message;
         }