Menu
▾
▴
[sbml-svn] SF.net SVN: sbml:[8450] branches/libsbml-new-api-3.3/src/xml
|
From: <sar...@us...> - 2008-11-26 02:24:01
|
Revision: 8450
http://sbml.svn.sourceforge.net/sbml/?rev=8450&view=rev
Author: sarahkeating
Date: 2008-11-26 02:23:49 +0000 (Wed, 26 Nov 2008)
Log Message:
-----------
added documentation of the return values for all set functions
Modified Paths:
--------------
branches/libsbml-new-api-3.3/src/xml/XMLAttributes.h
branches/libsbml-new-api-3.3/src/xml/XMLError.h
branches/libsbml-new-api-3.3/src/xml/XMLErrorLog.h
branches/libsbml-new-api-3.3/src/xml/XMLInputStream.h
branches/libsbml-new-api-3.3/src/xml/XMLParser.h
branches/libsbml-new-api-3.3/src/xml/XMLToken.cpp
branches/libsbml-new-api-3.3/src/xml/XMLToken.h
Modified: branches/libsbml-new-api-3.3/src/xml/XMLAttributes.h
===================================================================
--- branches/libsbml-new-api-3.3/src/xml/XMLAttributes.h 2008-11-25 23:55:03 UTC (rev 8449)
+++ branches/libsbml-new-api-3.3/src/xml/XMLAttributes.h 2008-11-26 02:23:49 UTC (rev 8450)
@@ -893,6 +893,13 @@
* attributeRequired() errors.
*
* @param log the log to use
+ *
+ * @return integer value indicating success/failure of the
+ * function. The value is drawn from the
+ * enumeration operationReturnValues_t. The possible values
+ * returned by this function are:
+ *
+ * LIBSBML_OPERATION_SUCCESS<br>
*/
int setErrorLog (XMLErrorLog* log);
Modified: branches/libsbml-new-api-3.3/src/xml/XMLError.h
===================================================================
--- branches/libsbml-new-api-3.3/src/xml/XMLError.h 2008-11-25 23:55:03 UTC (rev 8449)
+++ branches/libsbml-new-api-3.3/src/xml/XMLError.h 2008-11-26 02:23:49 UTC (rev 8450)
@@ -701,6 +701,13 @@
* Sets the line number where this error occurred.
*
* @param line an unsigned int, the line number to set.
+ *
+ * @return integer value indicating success/failure of the
+ * function. The value is drawn from the
+ * enumeration operationReturnValues_t. The possible values
+ * returned by this function are:
+ *
+ * LIBSBML_OPERATION_SUCCESS<br>
*/
int setLine (unsigned int line);
@@ -709,6 +716,13 @@
* Sets the column number where this error occurred.
*
* @param column an unsigned int, the column number to set.
+ *
+ * @return integer value indicating success/failure of the
+ * function. The value is drawn from the
+ * enumeration operationReturnValues_t. The possible values
+ * returned by this function are:
+ *
+ * LIBSBML_OPERATION_SUCCESS<br>
*/
int setColumn (unsigned int column);
Modified: branches/libsbml-new-api-3.3/src/xml/XMLErrorLog.h
===================================================================
--- branches/libsbml-new-api-3.3/src/xml/XMLErrorLog.h 2008-11-25 23:55:03 UTC (rev 8449)
+++ branches/libsbml-new-api-3.3/src/xml/XMLErrorLog.h 2008-11-26 02:23:49 UTC (rev 8450)
@@ -132,6 +132,14 @@
* application programs.
*
* @param p XMLParser, the parser to use
+ *
+ * @return integer value indicating success/failure of the
+ * function. The value is drawn from the
+ * enumeration operationReturnValues_t. The possible values
+ * returned by this function are:
+ *
+ * LIBSBML_OPERATION_SUCCESS<br>
+ * LIBSBML_OPERATION_FAILED<br>
*/
int setParser (const XMLParser* p);
Modified: branches/libsbml-new-api-3.3/src/xml/XMLInputStream.h
===================================================================
--- branches/libsbml-new-api-3.3/src/xml/XMLInputStream.h 2008-11-25 23:55:03 UTC (rev 8449)
+++ branches/libsbml-new-api-3.3/src/xml/XMLInputStream.h 2008-11-26 02:23:49 UTC (rev 8450)
@@ -143,6 +143,14 @@
/**
* Sets the XMLErrorLog this stream will use to log errors.
+ *
+ * @return integer value indicating success/failure of the
+ * function. The value is drawn from the
+ * enumeration operationReturnValues_t. The possible values
+ * returned by this function are:
+ *
+ * LIBSBML_OPERATION_SUCCESS<br>
+ * LIBSBML_OPERATION_FAILED<br>
*/
int setErrorLog (XMLErrorLog* log);
Modified: branches/libsbml-new-api-3.3/src/xml/XMLParser.h
===================================================================
--- branches/libsbml-new-api-3.3/src/xml/XMLParser.h 2008-11-25 23:55:03 UTC (rev 8449)
+++ branches/libsbml-new-api-3.3/src/xml/XMLParser.h 2008-11-26 02:23:49 UTC (rev 8450)
@@ -167,6 +167,14 @@
/**
* Sets the XMLErrorLog this parser will use to log errors.
+ *
+ * @return integer value indicating success/failure of the
+ * function. The value is drawn from the
+ * enumeration operationReturnValues_t. The possible values
+ * returned by this function are:
+ *
+ * LIBSBML_OPERATION_SUCCESS<br>
+ * LIBSBML_OPERATION_FAILED<br>
*/
int setErrorLog (XMLErrorLog* log);
Modified: branches/libsbml-new-api-3.3/src/xml/XMLToken.cpp
===================================================================
--- branches/libsbml-new-api-3.3/src/xml/XMLToken.cpp 2008-11-25 23:55:03 UTC (rev 8449)
+++ branches/libsbml-new-api-3.3/src/xml/XMLToken.cpp 2008-11-26 02:23:49 UTC (rev 8450)
@@ -1361,6 +1361,14 @@
* @param token XMLToken_t structure to be set.
* @param attributes XMLAttributes to be set to this XMLToken.
*
+ * @return integer value indicating success/failure of the
+ * function. The value is drawn from the
+ * enumeration operationReturnValues_t. The possible values
+ * returned by this function are:
+ *
+ * LIBSBML_OPERATION_SUCCESS<br>
+ * LIBSBML_INVALID_XML_OPERATION<br>
+ *
* @note This function replaces the existing XMLAttributes with the new one.
*/
LIBLAX_EXTERN
@@ -1909,6 +1917,14 @@
* @param token XMLToken_t structure to be queried.
* @param namespaces XMLNamespaces to be set to this XMLToken.
*
+ * @return integer value indicating success/failure of the
+ * function. The value is drawn from the
+ * enumeration operationReturnValues_t. The possible values
+ * returned by this function are:
+ *
+ * LIBSBML_OPERATION_SUCCESS<br>
+ * LIBSBML_INVALID_XML_OPERATION<br>
+ *
* @note This function replaces the existing XMLNamespaces with the new one.
*/
LIBLAX_EXTERN
@@ -2215,6 +2231,14 @@
*
* @param token XMLToken_t structure to be queried.
* @param triple an XMLTriple, the XML triple to be set to this XML element.
+ *
+ * @return integer value indicating success/failure of the
+ * function. The value is drawn from the
+ * enumeration operationReturnValues_t. The possible values
+ * returned by this function are:
+ *
+ * LIBSBML_OPERATION_SUCCESS<br>
+ * LIBSBML_INVALID_XML_OPERATION<br>
*/
LIBLAX_EXTERN
int
@@ -2379,6 +2403,13 @@
*
* @param token XMLToken_t structure to be set.
*
+ * @return integer value indicating success/failure of the
+ * function. The value is drawn from the
+ * enumeration operationReturnValues_t. The possible values
+ * returned by this function are:
+ *
+ * LIBSBML_OPERATION_SUCCESS<br>
+ * LIBSBML_OPERATION_FAILED<br>
*/
LIBLAX_EXTERN
int
@@ -2393,6 +2424,13 @@
*
* @param token XMLToken_t structure to be set.
*
+ * @return integer value indicating success/failure of the
+ * function. The value is drawn from the
+ * enumeration operationReturnValues_t. The possible values
+ * returned by this function are:
+ *
+ * LIBSBML_OPERATION_SUCCESS<br>
+ * LIBSBML_OPERATION_FAILED<br>
*/
LIBLAX_EXTERN
int
Modified: branches/libsbml-new-api-3.3/src/xml/XMLToken.h
===================================================================
--- branches/libsbml-new-api-3.3/src/xml/XMLToken.h 2008-11-25 23:55:03 UTC (rev 8449)
+++ branches/libsbml-new-api-3.3/src/xml/XMLToken.h 2008-11-26 02:23:49 UTC (rev 8450)
@@ -202,6 +202,14 @@
*
* @param attributes XMLAttributes to be set to this XMLToken.
*
+ * @return integer value indicating success/failure of the
+ * function. The value is drawn from the
+ * enumeration operationReturnValues_t. The possible values
+ * returned by this function are:
+ *
+ * LIBSBML_OPERATION_SUCCESS<br>
+ * LIBSBML_INVALID_XML_OPERATION<br>
+ *
* @note This function replaces the existing XMLAttributes with the new one.
*/
int setAttributes(const XMLAttributes& attributes);
@@ -532,6 +540,14 @@
*
* @param namespaces XMLNamespaces to be set to this XMLToken.
*
+ * @return integer value indicating success/failure of the
+ * function. The value is drawn from the
+ * enumeration operationReturnValues_t. The possible values
+ * returned by this function are:
+ *
+ * LIBSBML_OPERATION_SUCCESS<br>
+ * LIBSBML_INVALID_XML_OPERATION<br>
+ *
* @note This function replaces the existing XMLNamespaces with the new one.
*/
int setNamespaces(const XMLNamespaces& namespaces);
@@ -744,6 +760,14 @@
* Nothing will be done if this XML element is a text node.
*
* @param triple XMLTriple to be added to this XML element.
+ *
+ * @return integer value indicating success/failure of the
+ * function. The value is drawn from the
+ * enumeration operationReturnValues_t. The possible values
+ * returned by this function are:
+ *
+ * LIBSBML_OPERATION_SUCCESS<br>
+ * LIBSBML_INVALID_XML_OPERATION<br>
*/
int setTriple(const XMLTriple& triple);
@@ -869,12 +893,28 @@
/**
* Declares this XML start element is also an end element.
+ *
+ * @return integer value indicating success/failure of the
+ * function. The value is drawn from the
+ * enumeration operationReturnValues_t. The possible values
+ * returned by this function are:
+ *
+ * LIBSBML_OPERATION_SUCCESS<br>
+ * LIBSBML_OPERATION_FAILED<br>
*/
int setEnd ();
/**
* Declares this XMLToken is an end-of-file (input) marker.
+ *
+ * @return integer value indicating success/failure of the
+ * function. The value is drawn from the
+ * enumeration operationReturnValues_t. The possible values
+ * returned by this function are:
+ *
+ * LIBSBML_OPERATION_SUCCESS<br>
+ * LIBSBML_OPERATION_FAILED<br>
*/
int setEOF ();
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|