Преглед изворни кода

Update comments to reflect single successful return type

Benjamin Doherty пре 9 година
родитељ
комит
3b9cf99916
1 измењених фајлова са 8 додато и 8 уклоњено
  1. 8 8
      tinyxml2.h

+ 8 - 8
tinyxml2.h

@@ -1129,7 +1129,7 @@ public:
     }
     }
 
 
     /** QueryIntValue interprets the attribute as an integer, and returns the value
     /** QueryIntValue interprets the attribute as an integer, and returns the value
-    	in the provided parameter. The function will return XML_NO_ERROR on success,
+    	in the provided parameter. The function will return XML_SUCCESS on success,
     	and XML_WRONG_ATTRIBUTE_TYPE if the conversion is not successful.
     	and XML_WRONG_ATTRIBUTE_TYPE if the conversion is not successful.
     */
     */
     XMLError QueryIntValue( int* value ) const;
     XMLError QueryIntValue( int* value ) const;
@@ -1273,7 +1273,7 @@ public:
     }
     }
 
 
     /** Given an attribute name, QueryIntAttribute() returns
     /** Given an attribute name, QueryIntAttribute() returns
-    	XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion
+    	XML_SUCCESS, XML_WRONG_ATTRIBUTE_TYPE if the conversion
     	can't be performed, or XML_NO_ATTRIBUTE if the attribute
     	can't be performed, or XML_NO_ATTRIBUTE if the attribute
     	doesn't exist. If successful, the result of the conversion
     	doesn't exist. If successful, the result of the conversion
     	will be written to 'value'. If not successful, nothing will
     	will be written to 'value'. If not successful, nothing will
@@ -1338,7 +1338,7 @@ public:
 
 
 	
 	
     /** Given an attribute name, QueryAttribute() returns
     /** Given an attribute name, QueryAttribute() returns
-    	XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion
+    	XML_SUCCESS, XML_WRONG_ATTRIBUTE_TYPE if the conversion
     	can't be performed, or XML_NO_ATTRIBUTE if the attribute
     	can't be performed, or XML_NO_ATTRIBUTE if the attribute
     	doesn't exist. It is overloaded for the primitive types,
     	doesn't exist. It is overloaded for the primitive types,
 		and is a generally more convenient replacement of
 		and is a generally more convenient replacement of
@@ -1612,7 +1612,7 @@ public:
 
 
     /**
     /**
     	Parse an XML file from a character string.
     	Parse an XML file from a character string.
-    	Returns XML_NO_ERROR (0) on success, or
+    	Returns XML_SUCCESS (0) on success, or
     	an errorID.
     	an errorID.
 
 
     	You may optionally pass in the 'nBytes', which is
     	You may optionally pass in the 'nBytes', which is
@@ -1624,7 +1624,7 @@ public:
 
 
     /**
     /**
     	Load an XML file from disk.
     	Load an XML file from disk.
-    	Returns XML_NO_ERROR (0) on success, or
+    	Returns XML_SUCCESS (0) on success, or
     	an errorID.
     	an errorID.
     */
     */
     XMLError LoadFile( const char* filename );
     XMLError LoadFile( const char* filename );
@@ -1637,14 +1637,14 @@ public:
         not text in order for TinyXML-2 to correctly
         not text in order for TinyXML-2 to correctly
         do newline normalization.
         do newline normalization.
 
 
-    	Returns XML_NO_ERROR (0) on success, or
+    	Returns XML_SUCCESS (0) on success, or
     	an errorID.
     	an errorID.
     */
     */
     XMLError LoadFile( FILE* );
     XMLError LoadFile( FILE* );
 
 
     /**
     /**
     	Save the XML file to disk.
     	Save the XML file to disk.
-    	Returns XML_NO_ERROR (0) on success, or
+    	Returns XML_SUCCESS (0) on success, or
     	an errorID.
     	an errorID.
     */
     */
     XMLError SaveFile( const char* filename, bool compact = false );
     XMLError SaveFile( const char* filename, bool compact = false );
@@ -1653,7 +1653,7 @@ public:
     	Save the XML file to disk. You are responsible
     	Save the XML file to disk. You are responsible
     	for providing and closing the FILE*.
     	for providing and closing the FILE*.
 
 
-    	Returns XML_NO_ERROR (0) on success, or
+    	Returns XML_SUCCESS (0) on success, or
     	an errorID.
     	an errorID.
     */
     */
     XMLError SaveFile( FILE* fp, bool compact = false );
     XMLError SaveFile( FILE* fp, bool compact = false );