Improve documentation

[lgpl/argeo-commons.git] / org.argeo.api.cms / src / org / argeo / api / cms / CmsState.java

diff --git a/org.argeo.api.cms/src/org/argeo/api/cms/CmsState.java b/org.argeo.api.cms/src/org/argeo/api/cms/CmsState.java
index 8703b6b62d795d1d7e1cbb86aee0a707dbe7f4d2..3ccf0320687c62c3bacb4ba3c5044e0e29351f52 100644 (file)
--- a/org.argeo.api.cms/src/org/argeo/api/cms/CmsState.java
+++ b/org.argeo.api.cms/src/org/argeo/api/cms/CmsState.java
@@ -6,12 +6,15 @@ import java.util.UUID;
 
 /** A running node process. */
 public interface CmsState {
+       /** Local host on which this state is running. */
        String getHostname();
 
+       /** Since when this state has been available. */
        Long getAvailableSince();
 
        UUID getUuid();
 
+       /** A deploy property, or <code>null</code> if it is not set. */
        String getDeployProperty(String property);
 
        /**
@@ -20,7 +23,9 @@ public interface CmsState {
         */
        List<String> getDeployProperties(String property);
 
+       /** A local path in the data area. */
        Path getDataPath(String relativePath);
 
+       /** A local path in the state area. */
        Path getStatePath(String relativePath);
 }