IMmprove documentation

git-svn-id: https://svn.argeo.org/slc/trunk@5560 4cfe0d0a-d680-48aa-b62c-e0a02a3f76cc

diff --git a/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/test/context/ContextUtils.java b/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/test/context/ContextUtils.java
index ce1b000f3ee5022d9e88336f34b261cda32f8523..04281c21b344a808f2c47f7e87d4efb529b87606 100644 (file)
--- a/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/test/context/ContextUtils.java
+++ b/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/test/context/ContextUtils.java
@@ -26,6 +26,7 @@ import org.argeo.slc.test.TestStatus;
 import org.argeo.slc.test.context.ContextAware;\r
 import org.argeo.slc.test.context.ParentContextAware;\r
 \r
+/** Utilities for comparing and synchronising contexts. */\r
 public class ContextUtils {\r
        private final static Log log = LogFactory.getLog(ContextUtils.class);\r
 \r
@@ -97,8 +98,8 @@ public class ContextUtils {
                        // same keys\r
                        Map<String, Object> expectedValuesCommonChild = new TreeMap<String, Object>(\r
                                        expectedValuesCommon);\r
-                       putNotContained(expectedValuesCommonChild, child\r
-                                       .getExpectedValues());\r
+                       putNotContained(expectedValuesCommonChild,\r
+                                       child.getExpectedValues());\r
 \r
                        if (child instanceof ParentContextAware) {\r
                                // Recursive sync\r

diff --git a/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/test/context/ContextAware.java b/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/test/context/ContextAware.java
index 7ae88c59f947d8c07bdad4b54281cc84a298c757..2b8270b13f95f930be40b4dae1ed835f835679a0 100644 (file)
--- a/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/test/context/ContextAware.java
+++ b/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/test/context/ContextAware.java
@@ -17,14 +17,18 @@ package org.argeo.slc.test.context;
 \r
 import java.util.Map;\r
 \r
+/** Access to an SLC test context that is, maps of reached and expected values. */\r
 public interface ContextAware {\r
        public final static String DEFAULT_SKIP_FLAG = "!";\r
        public final static String DEFAULT_ANY_FLAG = "*";\r
 \r
+       /** Retrieves reached values. */\r
        public Map<String, Object> getValues();\r
 \r
+       /** Set reached values. */\r
        public void setValues(Map<String, Object> values);\r
 \r
+       /** Retrieves expected values. */\r
        public Map<String, Object> getExpectedValues();\r
 \r
        public String getContextSkipFlag();\r