doci mprovement.

git-svn-id: https://hudson.dev.java.net/svn/hudson/trunk/hudson/main@9207 71c3de6d-444a-0410-be80-ed276b4c234a
This commit is contained in:
kohsuke committed 2008-05-13 01:33:15 +00:00
1 parent 197a3012e4
commit fa3424ca2b
1 file changed
+8
@@ -53,6 +53,14 @@ public abstract class AbstractNodeMonitorDescriptor<T> extends Descriptor<NodeMo
/**
* Performs monitoring of the given computer object.
* This method is invoked periodically to perform the monitoring of the computer.
*
* @return
* Application-specific value that represents the observed monitoring value
* on the given node. This value will be returned from the {@link #get(Computer)} method.
* If null is returned, it will be interpreted as "no observed value." This is
* convenient way of abandoning the observation on a particular computer,
* whereas {@link IOException} is useful for indicating a hard error that needs to be
* corrected.
*/
protected abstract T monitor(Computer c) throws IOException,InterruptedException;