Return-Path: Delivered-To: apmail-jakarta-commons-dev-archive@www.apache.org Received: (qmail 82491 invoked from network); 28 Mar 2004 19:58:21 -0000 Received: from daedalus.apache.org (HELO mail.apache.org) (208.185.179.12) by minotaur-2.apache.org with SMTP; 28 Mar 2004 19:58:21 -0000 Received: (qmail 38141 invoked by uid 500); 28 Mar 2004 19:58:07 -0000 Delivered-To: apmail-jakarta-commons-dev-archive@jakarta.apache.org Received: (qmail 38075 invoked by uid 500); 28 Mar 2004 19:58:06 -0000 Mailing-List: contact commons-dev-help@jakarta.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Subscribe: List-Help: List-Post: List-Id: "Jakarta Commons Developers List" Reply-To: "Jakarta Commons Developers List" Delivered-To: mailing list commons-dev@jakarta.apache.org Received: (qmail 38035 invoked by uid 500); 28 Mar 2004 19:58:05 -0000 Received: (qmail 38018 invoked from network); 28 Mar 2004 19:58:05 -0000 Received: from unknown (HELO minotaur.apache.org) (209.237.227.194) by daedalus.apache.org with SMTP; 28 Mar 2004 19:58:05 -0000 Received: (qmail 82450 invoked by uid 1289); 28 Mar 2004 19:58:14 -0000 Date: 28 Mar 2004 19:58:14 -0000 Message-ID: <20040328195814.82449.qmail@minotaur.apache.org> From: rdonkin@apache.org To: jakarta-commons-cvs@apache.org Subject: cvs commit: jakarta-commons/jelly/jelly-tags/jaxme/src/java/org/apache/commons/jelly/tags/jaxme GeneratorTag.java JaxMeTagLibrary.java MarshallTag.java UnmarshallTag.java X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N X-Spam-Rating: minotaur-2.apache.org 1.6.2 0/1000/N rdonkin 2004/03/28 11:58:14 Modified: jelly/jelly-tags/jaxme/src/java/org/apache/commons/jelly/tags/jaxme GeneratorTag.java JaxMeTagLibrary.java MarshallTag.java UnmarshallTag.java Log: Improved javadocs for use in jellydoc Revision Changes Path 1.2 +12 -3 jakarta-commons/jelly/jelly-tags/jaxme/src/java/org/apache/commons/jelly/tags/jaxme/GeneratorTag.java Index: GeneratorTag.java =================================================================== RCS file: /home/cvs/jakarta-commons/jelly/jelly-tags/jaxme/src/java/org/apache/commons/jelly/tags/jaxme/GeneratorTag.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- GeneratorTag.java 25 Mar 2004 22:05:44 -0000 1.1 +++ GeneratorTag.java 28 Mar 2004 19:58:14 -0000 1.2 @@ -31,8 +31,9 @@ import org.apache.ws.jaxme.js.JavaSourceFactory; /** - * Tag that generates source from schema. - * Based on JaxMe XJCTask. + * Generates java objects using JaxMe. + * This object can be marshalled into xml and the results unmarshalled + * using JaxMe. * * @author Jochen Wiedmann * @author Jakarta Commons Development Team @@ -47,6 +48,10 @@ return schemaUrl; } + /** + * Defines the schema against which the java object representations + * should be generated. + */ public void setSchemaUrl(String schemaUrl) { this.schemaUrl = schemaUrl; } @@ -55,6 +60,10 @@ return target; } + /** + * Defines the target directory into which + * the generated objects will be placed. + */ public void setTarget(String target) { this.target = target; } 1.2 +5 -3 jakarta-commons/jelly/jelly-tags/jaxme/src/java/org/apache/commons/jelly/tags/jaxme/JaxMeTagLibrary.java Index: JaxMeTagLibrary.java =================================================================== RCS file: /home/cvs/jakarta-commons/jelly/jelly-tags/jaxme/src/java/org/apache/commons/jelly/tags/jaxme/JaxMeTagLibrary.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- JaxMeTagLibrary.java 25 Mar 2004 22:06:06 -0000 1.1 +++ JaxMeTagLibrary.java 28 Mar 2004 19:58:14 -0000 1.2 @@ -18,8 +18,10 @@ import org.apache.commons.jelly.TagLibrary; /** - * A Jelly custom tag library that uses the Betwixt project to parse XML and turn it into beans or - * turn beans into XML + * JAXB tag library + * using the Apache JaxMe implementation. + * The marshalling and unmarshalling tags should work with any JAXB implementation. + * The generation tag is JaxMe specific. * * @author Jakarta Commons Development Team * @version $Revision$ 1.2 +11 -3 jakarta-commons/jelly/jelly-tags/jaxme/src/java/org/apache/commons/jelly/tags/jaxme/MarshallTag.java Index: MarshallTag.java =================================================================== RCS file: /home/cvs/jakarta-commons/jelly/jelly-tags/jaxme/src/java/org/apache/commons/jelly/tags/jaxme/MarshallTag.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- MarshallTag.java 25 Mar 2004 22:06:47 -0000 1.1 +++ MarshallTag.java 28 Mar 2004 19:58:14 -0000 1.2 @@ -31,8 +31,10 @@ import org.xml.sax.SAXException; /** - * Tag that generates source from schema. - * Based on JaxMe XJCTask. + *

Marshalls a generated object generated by a JAXB implementation into xml.

+ *

+ * The result is placed into the processed content for further processing by enclosing + * tags.

* * @author Jochen Wiedmann * @author Jakarta Commons Development Team @@ -47,6 +49,9 @@ return packages; } + /** + * Defines the generated objects which will be marshalled by specifying the package name. + */ public void setPackages(String packages) { this.packages = packages; } @@ -55,6 +60,9 @@ return object; } + /** + * Defines the object to be unmarshalled into xml by specifying a jelly variable name. + */ public void setObject(Object object) { this.object = object; } 1.2 +14 -4 jakarta-commons/jelly/jelly-tags/jaxme/src/java/org/apache/commons/jelly/tags/jaxme/UnmarshallTag.java Index: UnmarshallTag.java =================================================================== RCS file: /home/cvs/jakarta-commons/jelly/jelly-tags/jaxme/src/java/org/apache/commons/jelly/tags/jaxme/UnmarshallTag.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- UnmarshallTag.java 25 Mar 2004 22:07:24 -0000 1.1 +++ UnmarshallTag.java 28 Mar 2004 19:58:14 -0000 1.2 @@ -37,15 +37,18 @@ import org.xml.sax.SAXException; /** - * Tag that generates source from schema. - * Based on JaxMe XJCTask. + *

Unmarshalls xml documents into java objects.

+ *

+ * This tag unmarshalls the xml content contained + * into the JaxMe generated java objects in the packages specified. + *

* * @author Jochen Wiedmann * @author Jakarta Commons Development Team * @version $Revision$ */ public class UnmarshallTag extends TagSupport { - + private String packages; private String var; @@ -53,6 +56,9 @@ return packages; } + /** + * Defines the generated objects to which the xml should be unmarshalled. + */ public void setPackages(String packages) { this.packages = packages; } @@ -61,6 +67,10 @@ return var; } + /** + * Sets the name of the jelly variable to which + * the unmarshalled java object should be bound. + */ public void setVar(String var) { this.var = var; } --------------------------------------------------------------------- To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org For additional commands, e-mail: commons-dev-help@jakarta.apache.org