activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tab...@apache.org
Subject svn commit: r776810 - /activemq/activemq-cpp/trunk/activemq-cpp-openwire-generator/src/main/java/org/apache/activemq/openwire/tool/marshallers/AmqCppMarshallingHeadersGenerator.java
Date Wed, 20 May 2009 19:22:18 GMT
Author: tabish
Date: Wed May 20 19:22:17 2009
New Revision: 776810

URL: http://svn.apache.org/viewvc?rev=776810&view=rev
Log:
Fix the generation of incorrect JavaDoc comments on the marshaling methods.

Modified:
    activemq/activemq-cpp/trunk/activemq-cpp-openwire-generator/src/main/java/org/apache/activemq/openwire/tool/marshallers/AmqCppMarshallingHeadersGenerator.java

Modified: activemq/activemq-cpp/trunk/activemq-cpp-openwire-generator/src/main/java/org/apache/activemq/openwire/tool/marshallers/AmqCppMarshallingHeadersGenerator.java
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp-openwire-generator/src/main/java/org/apache/activemq/openwire/tool/marshallers/AmqCppMarshallingHeadersGenerator.java?rev=776810&r1=776809&r2=776810&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp-openwire-generator/src/main/java/org/apache/activemq/openwire/tool/marshallers/AmqCppMarshallingHeadersGenerator.java
(original)
+++ activemq/activemq-cpp/trunk/activemq-cpp-openwire-generator/src/main/java/org/apache/activemq/openwire/tool/marshallers/AmqCppMarshallingHeadersGenerator.java
Wed May 20 19:22:17 2009
@@ -207,12 +207,14 @@
 
 out.println("        /**");
 out.println("         * Creates a new instance of this marshalable type.");
+out.println("         *");
 out.println("         * @return new DataStructure object pointer caller owns it.");
 out.println("         */");
 out.println("        virtual commands::DataStructure* createObject() const;");
 out.println("");
 out.println("        /**");
 out.println("         * Get the Data Structure Type that identifies this Marshaler");
+out.println("         *");
 out.println("         * @return byte holding the data structure type value");
 out.println("         */");
 out.println("        virtual unsigned char getDataStructureType() const;");
@@ -220,10 +222,13 @@
     }
 out.println("        /**");
 out.println("         * Un-marshal an object instance from the data input stream");
+out.println("         *");
 out.println("         * @param wireFormat - describes the wire format of the broker");
-out.println("         * @param o - Object to be un-marshaled");
+out.println("         * @param dataStructure - Object to be un-marshaled");
 out.println("         * @param dataIn - BinaryReader that provides that data");
 out.println("         * @param bs - BooleanStream");
+out.println("         *");
+out.println("         * @throws IOException if an error occurs during the unmarshal.");
 out.println("         */");
 out.println("        virtual void tightUnmarshal( OpenWireFormat* wireFormat,");
 out.println("                                     commands::DataStructure* dataStructure,");
@@ -232,10 +237,13 @@
 out.println("");
 out.println("        /**");
 out.println("         * Write the booleans that this object uses to a BooleanStream");
+out.println("         *");
 out.println("         * @param wireFormat - describes the wire format of the broker");
-out.println("         * @param o - Object to be marshaled");
+out.println("         * @param dataStructure - Object to be marshaled");
 out.println("         * @param bs - BooleanStream");
-out.println("         * @returns int");
+out.println("         * @returns int value indicating the size of the marshaled object.");
+out.println("         *");
+out.println("         * @throws IOException if an error occurs during the marshal.");
 out.println("         */");
 out.println("        virtual int tightMarshal1( OpenWireFormat* wireFormat,");
 out.println("                                   commands::DataStructure* dataStructure,");
@@ -243,10 +251,13 @@
 out.println("");
 out.println("        /**");
 out.println("         * Write a object instance to data output stream");
+out.println("         *");
 out.println("         * @param wireFormat - describes the wire format of the broker");
-out.println("         * @param o - Object to be marshaled");
+out.println("         * @param dataStructure - Object to be marshaled");
 out.println("         * @param dataOut - BinaryReader that provides that data sink");
 out.println("         * @param bs - BooleanStream");
+out.println("         *");
+out.println("         * @throws IOException if an error occurs during the marshal.");
 out.println("         */");
 out.println("        virtual void tightMarshal2( OpenWireFormat* wireFormat,");
 out.println("                                    commands::DataStructure* dataStructure,");
@@ -255,9 +266,12 @@
 out.println("");
 out.println("        /**");
 out.println("         * Un-marshal an object instance from the data input stream");
+out.println("         *");
 out.println("         * @param wireFormat - describes the wire format of the broker");
-out.println("         * @param o - Object to be marshaled");
+out.println("         * @param dataStructure - Object to be marshaled");
 out.println("         * @param dataIn - BinaryReader that provides that data source");
+out.println("         *");
+out.println("         * @throws IOException if an error occurs during the unmarshal.");
 out.println("         */");
 out.println("        virtual void looseUnmarshal( OpenWireFormat* wireFormat,");
 out.println("                                     commands::DataStructure* dataStructure,");
@@ -265,9 +279,12 @@
 out.println("");
 out.println("        /**");
 out.println("         * Write a object instance to data output stream");
+out.println("         *");
 out.println("         * @param wireFormat - describs the wire format of the broker");
-out.println("         * @param o - Object to be marshaled");
+out.println("         * @param dataStructure - Object to be marshaled");
 out.println("         * @param dataOut - BinaryWriter that provides that data sink");
+out.println("         *");
+out.println("         * @throws IOException if an error occurs during the marshal.");
 out.println("         */");
 out.println("        virtual void looseMarshal( OpenWireFormat* wireFormat,");
 out.println("                                   commands::DataStructure* dataStructure,");



Mime
View raw message