diff options
Diffstat (limited to 'ACEXML')
| -rw-r--r-- | ACEXML/common/Transcode.h | 18 | ||||
| -rw-r--r-- | ACEXML/parser/parser/Parser.h | 13 |
2 files changed, 16 insertions, 15 deletions
diff --git a/ACEXML/common/Transcode.h b/ACEXML/common/Transcode.h index ca68e515c18..427784891db 100644 --- a/ACEXML/common/Transcode.h +++ b/ACEXML/common/Transcode.h @@ -57,7 +57,7 @@ public: /* * Convert a UTF-16 character into a string in UTF-8 encoding. * - * @retval number of characters the function uses to store the + * @return number of characters the function uses to store the * converted string if succeeds or one of the error STATUS * otherwise. */ @@ -68,7 +68,7 @@ public: /* * Convert a UCS-4 character into a string in UTF-8 encoding. * - * @retval number of characters the function uses to store the + * @return number of characters the function uses to store the * converted string if succeeds or one of the error STATUS * otherwise. */ @@ -79,7 +79,7 @@ public: /* * Convert a UCS-4 character into a string in UTF-16 encoding. * - * @retval number of characters the function uses to store the + * @return number of characters the function uses to store the * converted string if succeeds or one of the error STATUS * otherwise. */ @@ -90,7 +90,7 @@ public: /* * Convert a UTF-16 surrogate character pair into a string in UTF-8 encoding. * - * @retval number of characters the function uses to store the + * @return number of characters the function uses to store the * converted string if succeeds or one of the error STATUS * otherwise. */ @@ -102,7 +102,7 @@ public: /* * Convert a UTF-16 surrogate character pair into a UCS-4 character. * - * @retval SUCCESS if succeeds or one of the error STATUS + * @return SUCCESS if succeeds or one of the error STATUS * otherwise. */ static int surrogate2ucs4 (ACEXML_UTF16 high, @@ -113,7 +113,7 @@ public: * Convert the first UNICODE character in a UTF-8 character string * into a UCS-4 character. * - * @retval number of characters the function consumed from the + * @return number of characters the function consumed from the * UTF-8 string if succeeds or one of the error STATUS * otherwise. */ @@ -125,7 +125,7 @@ public: * Convert the first UNICODE character in a UTF-16 character string * into a UCS-4 character. * - * @retval number of characters the function consumed from the + * @return number of characters the function consumed from the * UTF-16 string if succeeds or one of the error STATUS * otherwise. */ @@ -145,7 +145,7 @@ public: * * @param len The length of @a dst string. * - * @retval number of characters the function consumed from the + * @return number of characters the function consumed from the * UTF-8 string if succeeds or one of the error STATUS * otherwise. */ @@ -158,7 +158,7 @@ public: * * @param len The length of @a dst string. * - * @retval number of characters the function uses in + * @return number of characters the function uses in * UTF-8 string if succeeds or one of the error STATUS * otherwise. */ diff --git a/ACEXML/parser/parser/Parser.h b/ACEXML/parser/parser/Parser.h index 68401b5bf0c..bcb31d43a62 100644 --- a/ACEXML/parser/parser/Parser.h +++ b/ACEXML/parser/parser/Parser.h @@ -154,9 +154,9 @@ public: * whitespace after proper conversion. Null if there's no * whitespace found. * - * @retval The first none-white space characters (which will be + * @return The first none-white space characters (which will be * consumed from the CharStream.) If no whitespace is found, it - * will return 0. + * returns 0. * * @sa skip_whitespace_count */ @@ -172,7 +172,7 @@ public: * skip_whitespace_count stores the first non-whitespace * character it sees (character is not removed from the stream.) * - * @retval The number of whitespace characters consumed. + * @return The number of whitespace characters consumed. * * @sa skip_whitespace */ @@ -239,7 +239,7 @@ public: * character from the input CharStream, otherwise, read_name * will use this->get() to acquire the initial character. * - * @retval A pointer to the string in the obstack, 0 if it's not + * @return A pointer to the string in the obstack, 0 if it's not * a valid name. */ ACEXML_Char *read_name (ACEXML_Char ch = 0); @@ -289,7 +289,7 @@ public: * Parse an entity reference, i.e., "&". The first character * encountered should be the character following '&'. * - * @retval A pointer to the resolved const ACEXML_String if success + * @return A pointer to the resolved const ACEXML_String if success * (previously defined), 0 otherwise. */ const ACEXML_String *parse_reference (void); @@ -298,7 +298,8 @@ public: * Parse a CDATA section. The first character should always be the first * '[' in CDATA definition. * - * @retval 0 on success, -1 otherwise. + * @retval 0 on success. + * @retval -1 if fail. */ int parse_cdata (ACEXML_Env &xmlenv); |