svn commit: r981018 - in /ofbiz/trunk/framework/service: dtd/services.xsd src/org/ofbiz/service/ModelParam.java src/org/ofbiz/service/ModelServiceReader.java

[lektran]

Author: lektran
Date: Sat Jul 31 08:26:42 2010
New Revision: 981018

URL: http://svn.apache.org/viewvc?rev=981018&view=rev
Log:
Add a description element for service attributes, should make documenting some services a little easier.  Still need to display it in webtools somewhere.

Modified:
    ofbiz/trunk/framework/service/dtd/services.xsd
    ofbiz/trunk/framework/service/src/org/ofbiz/service/ModelParam.java
    ofbiz/trunk/framework/service/src/org/ofbiz/service/ModelServiceReader.java

Modified: ofbiz/trunk/framework/service/dtd/services.xsd
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/service/dtd/services.xsd?rev=981018&r1=981017&r2=981018&view=diff
==============================================================================
--- ofbiz/trunk/framework/service/dtd/services.xsd (original)
+++ ofbiz/trunk/framework/service/dtd/services.xsd Sat Jul 31 08:26:42 2010
@@ -314,6 +314,7 @@ under the License.
         <xs:complexType>
             <xs:sequence>
                 <xs:element minOccurs="0" maxOccurs="unbounded" ref="type-validate"/>
+                <xs:element minOccurs="0" ref="description" />
             </xs:sequence>
             <xs:attributeGroup ref="attlist.attribute"/>
         </xs:complexType>

Modified: ofbiz/trunk/framework/service/src/org/ofbiz/service/ModelParam.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/service/src/org/ofbiz/service/ModelParam.java?rev=981018&r1=981017&r2=981018&view=diff
==============================================================================
--- ofbiz/trunk/framework/service/src/org/ofbiz/service/ModelParam.java (original)
+++ ofbiz/trunk/framework/service/src/org/ofbiz/service/ModelParam.java Sat Jul 31 08:26:42 2010
@@ -43,6 +43,9 @@ public class ModelParam implements Seria
     /** Parameter name */
     public String name;
 
+    /** The description of this parameter */
+    public String description;
+
     /** Paramater type */
     public String type;
 
@@ -88,6 +91,7 @@ public class ModelParam implements Seria
 
     public ModelParam(ModelParam param) {
         this.name = param.name;
+        this.description = param.description;
         this.type = param.type;
         this.mode = param.mode;
         this.formLabel = param.formLabel;

Modified: ofbiz/trunk/framework/service/src/org/ofbiz/service/ModelServiceReader.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/service/src/org/ofbiz/service/ModelServiceReader.java?rev=981018&r1=981017&r2=981018&view=diff
==============================================================================
--- ofbiz/trunk/framework/service/src/org/ofbiz/service/ModelServiceReader.java (original)
+++ ofbiz/trunk/framework/service/src/org/ofbiz/service/ModelServiceReader.java Sat Jul 31 08:26:42 2010
@@ -518,6 +518,7 @@ public class ModelServiceReader implemen
             ModelParam param = new ModelParam();
 
             param.name = UtilXml.checkEmpty(attribute.getAttribute("name")).intern();
+            param.description = getCDATADef(baseElement, "description");
             param.type = UtilXml.checkEmpty(attribute.getAttribute("type")).intern();
             param.mode = UtilXml.checkEmpty(attribute.getAttribute("mode")).intern();
             param.entityName = UtilXml.checkEmpty(attribute.getAttribute("entity-name")).intern();