Improve documentation.

[gpl/argeo-slc.git] / org.argeo.slc / src / main / java / org / argeo / slc / ant / spring / OverrideArg.java

diff --git a/org.argeo.slc/src/main/java/org/argeo/slc/ant/spring/OverrideArg.java b/org.argeo.slc/src/main/java/org/argeo/slc/ant/spring/OverrideArg.java
index 85a6e2c89100f55de07adfe7d15f7a5098aaf91b..80eb4731b388390a90f67222d034d2f63cb55197 100644 (file)
--- a/org.argeo.slc/src/main/java/org/argeo/slc/ant/spring/OverrideArg.java
+++ b/org.argeo.slc/src/main/java/org/argeo/slc/ant/spring/OverrideArg.java
@@ -2,11 +2,12 @@ package org.argeo.slc.ant.spring;
 \r
 import org.apache.tools.ant.BuildException;\r
 \r
-\r
+/** Ant type allowing to override bean properties. */\r
 public class OverrideArg extends AbstractSpringArg {\r
        private String name;\r
        private Object value;\r
 \r
+       /** The nbame of the property to override. */\r
        public String getName() {\r
                return name;\r
        }\r
@@ -15,6 +16,7 @@ public class OverrideArg extends AbstractSpringArg {
                this.name = name;\r
        }\r
 \r
+       /** Both value and bean cannot be set. */\r
        public void setValue(String value) {\r
                if (getBean() != null) {\r
                        throw new BuildException(\r
@@ -32,6 +34,10 @@ public class OverrideArg extends AbstractSpringArg {
                super.setBean(bean);\r
        }\r
 \r
+       /**\r
+        * The related object: the value if a value had been set or an instance of\r
+        * the bean if not.\r
+        */\r
        public Object getObject() {\r
                if (value != null) {\r
                        return value;\r