Improve documentation
authorMathieu Baudier <mbaudier@argeo.org>
Mon, 29 May 2023 08:27:32 +0000 (10:27 +0200)
committerMathieu Baudier <mbaudier@argeo.org>
Mon, 29 May 2023 08:27:32 +0000 (10:27 +0200)
org.argeo.init/src/org/argeo/init/RuntimeContext.java
org.argeo.init/src/org/argeo/init/Service.java

index 1d3c743ca765b85b564a8cf9f8ff213158463a79..d83f2ca1c22cb04bf7fad1a1a95e1ce575d256b5 100644 (file)
@@ -1,7 +1,10 @@
 package org.argeo.init;
 
+/** A runtime context with a life cycle. */
 public interface RuntimeContext extends Runnable {
+       /** Wait until this runtime context has closed. */
        void waitForStop(long timeout) throws InterruptedException;
 
+       /** Close this runtime context. */
        void close() throws Exception;
 }
index cab85d02ff3e8eefa19317916ebf0de3f286af30..c1eb76d0b1ed621d277e6f0f8aaee8d68bee0f9d 100644 (file)
@@ -106,6 +106,7 @@ public class Service {
                logger.log(Logger.Level.DEBUG, "Argeo Init stopped with PID " + pid);
        }
 
+       /** The root runtime context in this JVM. */
        public static RuntimeContext getRuntimeContext() {
                return runtimeContext;
        }