From: Mathieu Baudier <mbaudier@argeo.org>
Date: Mon, 29 May 2023 08:27:32 +0000 (+0200)
Subject: Improve documentation
X-Git-Tag: v2.3.17~9
X-Git-Url: https://git.argeo.org/?a=commitdiff_plain;h=7d781139f410e6420f5bf6d3f0fbae2385a5695b;p=lgpl%2Fargeo-commons.git

Improve documentation
---

diff --git a/org.argeo.init/src/org/argeo/init/RuntimeContext.java b/org.argeo.init/src/org/argeo/init/RuntimeContext.java
index 1d3c743ca..d83f2ca1c 100644
--- a/org.argeo.init/src/org/argeo/init/RuntimeContext.java
+++ b/org.argeo.init/src/org/argeo/init/RuntimeContext.java
@@ -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;
 }
diff --git a/org.argeo.init/src/org/argeo/init/Service.java b/org.argeo.init/src/org/argeo/init/Service.java
index cab85d02f..c1eb76d0b 100644
--- a/org.argeo.init/src/org/argeo/init/Service.java
+++ b/org.argeo.init/src/org/argeo/init/Service.java
@@ -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;
 	}