OpenE2K
/
gcc
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

basic_string.h, [...]: Fix Doxygen comments that use wrong parameter and function names. 

* include/bits/basic_string.h, include/bits/locale_facets.h: Fix
	Doxygen comments that use wrong parameter and function names.

From-SVN: r101419
This commit is contained in:
Jonathan Wakely 2005-06-29 13:18:08 +01:00
parent 7d31a1f437
commit a65da37d5b
3 changed files with 22 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
libstdc++-v3/ChangeLog
View File

@ -1,3 +1,8 @@
2005-06-29 Jonathan Wakely <redi@gcc.gnu.org>
* include/bits/basic_string.h, include/bits/locale_facets.h: Fix
Doxygen comments that use wrong parameter and function names.
2005-06-29 Paolo Carlini <pcarlini@suse.de> 2005-06-29 Paolo Carlini <pcarlini@suse.de>
* docs/html/ext/lwg-active.html, lwg-defects.html: Import Revision 37. * docs/html/ext/lwg-active.html, lwg-defects.html: Import Revision 37.

26
libstdc++-v3/include/bits/basic_string.h
View File

@ -404,7 +404,7 @@ namespace std
basic_string(); basic_string();
/** /**
* @brief Construct an empty string using allocator a. * @brief Construct an empty string using allocator @a a.
*/ */
explicit explicit
basic_string(const _Alloc& __a); basic_string(const _Alloc& __a);
@ -439,7 +439,7 @@ namespace std
* @param n Number of characters to copy. * @param n Number of characters to copy.
* @param a Allocator to use (default is default allocator). * @param a Allocator to use (default is default allocator).
* *
* NB: s must have at least n characters, '\0' has no special * NB: @a s must have at least @a n characters, '\0' has no special
* meaning. * meaning.
*/ */
basic_string(const _CharT* __s, size_type __n, basic_string(const _CharT* __s, size_type __n,
@ -636,8 +636,8 @@ namespace std
/** /**
* @brief Attempt to preallocate enough memory for specified number of * @brief Attempt to preallocate enough memory for specified number of
* characters. * characters.
* @param n Number of characters required. * @param res_arg Number of characters required.
* @throw std::length_error If @a n exceeds @c max_size(). * @throw std::length_error If @a res_arg exceeds @c max_size().
* *
* This function attempts to reserve enough memory for the * This function attempts to reserve enough memory for the
* %string to hold the specified number of characters. If the * %string to hold the specified number of characters. If the
@ -670,7 +670,7 @@ namespace std
// Element access: // Element access:
/** /**
* @brief Subscript access to the data contained in the %string. * @brief Subscript access to the data contained in the %string.
* @param n The index of the character to access. * @param pos The index of the character to access.
* @return Read-only (constant) reference to the character. * @return Read-only (constant) reference to the character.
* *
* This operator allows for easy, array-style, data access. * This operator allows for easy, array-style, data access.
@ -687,7 +687,7 @@ namespace std
/** /**
* @brief Subscript access to the data contained in the %string. * @brief Subscript access to the data contained in the %string.
* @param n The index of the character to access. * @param pos The index of the character to access.
* @return Read/write reference to the character. * @return Read/write reference to the character.
* *
* This operator allows for easy, array-style, data access. * This operator allows for easy, array-style, data access.
@ -765,7 +765,7 @@ namespace std
/** /**
* @brief Append a character. * @brief Append a character.
* @param s The character to append. * @param c The character to append.
* @return Reference to this string. * @return Reference to this string.
*/ */
basic_string& basic_string&
@ -1204,15 +1204,15 @@ namespace std
* @brief Replace characters with value of a C substring. * @brief Replace characters with value of a C substring.
* @param pos Index of first character to replace. * @param pos Index of first character to replace.
* @param n1 Number of characters to be replaced. * @param n1 Number of characters to be replaced.
* @param str C string to insert. * @param s C string to insert.
* @param n2 Number of characters from str to use. * @param n2 Number of characters from @a s to use.
* @return Reference to this string. * @return Reference to this string.
* @throw std::out_of_range If @a pos1 > size(). * @throw std::out_of_range If @a pos1 > size().
* @throw std::length_error If new length exceeds @c max_size(). * @throw std::length_error If new length exceeds @c max_size().
* *
* Removes the characters in the range [pos,pos + n1) from this string. * Removes the characters in the range [pos,pos + n1) from this string.
* In place, the first @a n2 characters of @a str are inserted, or all * In place, the first @a n2 characters of @a s are inserted, or all
* of @a str if @a n2 is too large. If @a pos is beyond end of string, * of @a s if @a n2 is too large. If @a pos is beyond end of string,
* out_of_range is thrown. If the length of result exceeds max_size(), * out_of_range is thrown. If the length of result exceeds max_size(),
* length_error is thrown. The value of the string doesn't change if * length_error is thrown. The value of the string doesn't change if
* an error is thrown. * an error is thrown.
@ -1225,13 +1225,13 @@ namespace std
* @brief Replace characters with value of a C string. * @brief Replace characters with value of a C string.
* @param pos Index of first character to replace. * @param pos Index of first character to replace.
* @param n1 Number of characters to be replaced. * @param n1 Number of characters to be replaced.
* @param str C string to insert. * @param s C string to insert.
* @return Reference to this string. * @return Reference to this string.
* @throw std::out_of_range If @a pos > size(). * @throw std::out_of_range If @a pos > size().
* @throw std::length_error If new length exceeds @c max_size(). * @throw std::length_error If new length exceeds @c max_size().
* *
* Removes the characters in the range [pos,pos + n1) from this string. * Removes the characters in the range [pos,pos + n1) from this string.
* In place, the first @a n characters of @a str are inserted. If @a * In place, the first @a n characters of @a s are inserted. If @a
* pos is beyond end of string, out_of_range is thrown. If the length * pos is beyond end of string, out_of_range is thrown. If the length
* of result exceeds max_size(), length_error is thrown. The value of * of result exceeds max_size(), length_error is thrown. The value of
* the string doesn't change if an error is thrown. * the string doesn't change if an error is thrown.

8
libstdc++-v3/include/bits/locale_facets.h
View File

@ -1950,7 +1950,7 @@ namespace std
* @brief Numeric parsing. * @brief Numeric parsing.
* *
* Parses the input stream into the bool @a v. It does so by calling * Parses the input stream into the bool @a v. It does so by calling
* num_put::do_put(). * num_get::do_get().
* *
* If ios_base::boolalpha is set, attempts to read * If ios_base::boolalpha is set, attempts to read
* ctype<CharT>::truename() or ctype<CharT>::falsename(). Sets * ctype<CharT>::truename() or ctype<CharT>::falsename(). Sets
@ -1979,7 +1979,7 @@ namespace std
* @brief Numeric parsing. * @brief Numeric parsing.
* *
* Parses the input stream into the integral variable @a v. It does so * Parses the input stream into the integral variable @a v. It does so
* by calling num_put::do_put(). * by calling num_get::do_get().
* *
* Parsing is affected by the flag settings in @a io. * Parsing is affected by the flag settings in @a io.
* *
@ -2043,7 +2043,7 @@ namespace std
* @brief Numeric parsing. * @brief Numeric parsing.
* *
* Parses the input stream into the integral variable @a v. It does so * Parses the input stream into the integral variable @a v. It does so
* by calling num_put::do_put(). * by calling num_get::do_get().
* *
* The input characters are parsed like the scanf %g specifier. The * The input characters are parsed like the scanf %g specifier. The
* matching type length modifier is also used. * matching type length modifier is also used.
@ -2084,7 +2084,7 @@ namespace std
* @brief Numeric parsing. * @brief Numeric parsing.
* *
* Parses the input stream into the pointer variable @a v. It does so * Parses the input stream into the pointer variable @a v. It does so
* by calling num_put::do_put(). * by calling num_get::do_get().
* *
* The input characters are parsed like the scanf %p specifier. * The input characters are parsed like the scanf %p specifier.
* *