[multiple changes]

2010-02-08  Benjamin Kosnik  <bkoz@redhat.com>

	PR libstdc++/42460
	* include/tr1_impl/regex: Fix quoting issues in doxygen markup.
	* include/bits/random.h: Fix multi-line doxygen function markup.

2010-02-08  Matthias Klose  <doko@debian.org>

	PR libstdc++/42460
	* include/std/istream: Fix '\' quoting in doxygen markup.

From-SVN: r156617
This commit is contained in:
Benjamin Kosnik 2010-02-09 04:49:49 +00:00
parent 85db3dc16c
commit 6cc5a79001
4 changed files with 98 additions and 75 deletions

View File

@ -1,3 +1,14 @@
2010-02-08 Benjamin Kosnik <bkoz@redhat.com>
PR libstdc++/42460
* include/tr1_impl/regex: Fix quoting issues in doxygen markup.
* include/bits/random.h: Fix multi-line doxygen function markup.
2010-02-08 Matthias Klose <doko@debian.org>
PR libstdc++/42460
* include/std/istream: Fix '\' quoting in doxygen markup.
2010-02-08 Ed Smith-Rowland <3dw4rd@verizon.net>
* include/bits/random.tcc (uniform_int_distribution<>::

View File

@ -137,8 +137,11 @@ namespace std
/**
* @brief A model of a linear congruential random number generator.
*
* A random number generator that produces pseudorandom numbers using the
* linear function @f$x_{i+1}\leftarrow(ax_{i} + c) \bmod m @f$.
* A random number generator that produces pseudorandom numbers via
* linear function:
* @f[
* x_{i+1}\leftarrow(ax_{i} + c) \bmod m
* @f]
*
* The template parameter @p _UIntType must be an unsigned integral type
* large enough to store values up to (__m-1). If the template parameter
@ -527,11 +530,13 @@ namespace std
* generator, sometimes referred to as the SWC generator.
*
* A discrete random number generator that produces pseudorandom
* numbers using @f$x_{i}\leftarrow(x_{i - s} - x_{i - r} -
* carry_{i-1}) \bmod m @f$.
* numbers using:
* @f[
* x_{i}\leftarrow(x_{i - s} - x_{i - r} - carry_{i-1}) \bmod m
* @f]
*
* The size of the state is @f$r@f$
* and the maximum period of the generator is @f$ m^r - m^s - 1 @f$.
* and the maximum period of the generator is @f$(m^r - m^s - 1)@f$.
*
* @var _M_x The state of the generator. This is a ring buffer.
* @var _M_carry The carry.
@ -1364,9 +1369,6 @@ namespace std
0xfff7eee000000000ULL, 43,
6364136223846793005ULL> mt19937_64;
/**
* .
*/
typedef subtract_with_carry_engine<uint_fast32_t, 24, 10, 24>
ranlux24_base;
@ -1377,14 +1379,8 @@ namespace std
typedef discard_block_engine<ranlux48_base, 389, 11> ranlux48;
/**
* .
*/
typedef shuffle_order_engine<minstd_rand0, 256> knuth_b;
/**
* .
*/
typedef minstd_rand0 default_random_engine;
/**
@ -1809,8 +1805,10 @@ namespace std
* @brief A normal continuous distribution for random numbers.
*
* The formula for the normal probability density function is
* @f$ p(x|\mu,\sigma) = \frac{1}{\sigma \sqrt{2 \pi}}
* e^{- \frac{{x - \mu}^ {2}}{2 \sigma ^ {2}} } @f$.
* @f[
* p(x|\mu,\sigma) = \frac{1}{\sigma \sqrt{2 \pi}}
* e^{- \frac{{x - \mu}^ {2}}{2 \sigma ^ {2}} }
* @f]
*/
template<typename _RealType = double>
class normal_distribution
@ -1964,8 +1962,10 @@ namespace std
* @brief A lognormal_distribution random number distribution.
*
* The formula for the normal probability mass function is
* @f$ p(x|m,s) = \frac{1}{sx\sqrt{2\pi}}
* \exp{-\frac{(\ln{x} - m)^2}{2s^2}} @f$
* @f[
* p(x|m,s) = \frac{1}{sx\sqrt{2\pi}}
* \exp{-\frac{(\ln{x} - m)^2}{2s^2}}
* @f]
*/
template<typename _RealType = double>
class lognormal_distribution
@ -2109,9 +2109,11 @@ namespace std
/**
* @brief A gamma continuous distribution for random numbers.
*
* The formula for the gamma probability density function is
* @f$ p(x|\alpha,\beta) = \frac{1}{\beta\Gamma(\alpha)}
* (x/\beta)^{\alpha - 1} e^{-x/\beta} @f$.
* The formula for the gamma probability density function is:
* @f[
* p(x|\alpha,\beta) = \frac{1}{\beta\Gamma(\alpha)}
* (x/\beta)^{\alpha - 1} e^{-x/\beta}
* @f]
*/
template<typename _RealType = double>
class gamma_distribution
@ -2551,9 +2553,11 @@ namespace std
* @brief A fisher_f_distribution random number distribution.
*
* The formula for the normal probability mass function is
* @f$ p(x|m,n) = \frac{\Gamma((m+n)/2)}{\Gamma(m/2)\Gamma(n/2)}
* @f[
* p(x|m,n) = \frac{\Gamma((m+n)/2)}{\Gamma(m/2)\Gamma(n/2)}
* (\frac{m}{n})^{m/2} x^{(m/2)-1}
* (1 + \frac{mx}{n})^{-(m+n)/2} @f$
* (1 + \frac{mx}{n})^{-(m+n)/2}
* @f]
*/
template<typename _RealType = double>
class fisher_f_distribution
@ -2705,9 +2709,11 @@ namespace std
/**
* @brief A student_t_distribution random number distribution.
*
* The formula for the normal probability mass function is
* @f$ p(x|n) = \frac{1}{\sqrt(n\pi)} \frac{\Gamma((n+1)/2)}{\Gamma(n/2)}
* (1 + \frac{x^2}{n}) ^{-(n+1)/2} @f$
* The formula for the normal probability mass function is:
* @f[
* p(x|n) = \frac{1}{\sqrt(n\pi)} \frac{\Gamma((n+1)/2)}{\Gamma(n/2)}
* (1 + \frac{x^2}{n}) ^{-(n+1)/2}
* @f]
*/
template<typename _RealType = double>
class student_t_distribution
@ -3781,9 +3787,11 @@ namespace std
/**
* @brief A weibull_distribution random number distribution.
*
* The formula for the normal probability density function is
* @f$ p(x|\alpha,\beta) = \frac{\alpha}{\beta} (\frac{x}{\beta})^{\alpha-1}
* \exp{(-(\frac{x}{\beta})^\alpha)} @f$.
* The formula for the normal probability density function is:
* @f[
* p(x|\alpha,\beta) = \frac{\alpha}{\beta} (\frac{x}{\beta})^{\alpha-1}
* \exp{(-(\frac{x}{\beta})^\alpha)}
* @f]
*/
template<typename _RealType = double>
class weibull_distribution
@ -3928,8 +3936,10 @@ namespace std
* @brief A extreme_value_distribution random number distribution.
*
* The formula for the normal probability mass function is
* @f$ p(x|a,b) = \frac{1}{b}
* \exp( \frac{a-x}{b} - \exp(\frac{a-x}{b})) @f$
* @f[
* p(x|a,b) = \frac{1}{b}
* \exp( \frac{a-x}{b} - \exp(\frac{a-x}{b}))
* @f]
*/
template<typename _RealType = double>
class extreme_value_distribution

View File

@ -327,7 +327,7 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
* @param n Maximum number of characters to store in @a s.
* @return *this
*
* Returns @c get(s,n,widen(&apos;\n&apos;)).
* Returns @c get(s,n,widen(&apos;\\n&apos;)).
*/
__istream_type&
get(char_type* __s, streamsize __n)
@ -360,7 +360,7 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
* @param sb A streambuf in which to store data.
* @return *this
*
* Returns @c get(sb,widen(&apos;\n&apos;)).
* Returns @c get(sb,widen(&apos;\\n&apos;)).
*/
__istream_type&
get(__streambuf_type& __sb)
@ -400,7 +400,7 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
* @param n Maximum number of characters to extract.
* @return *this
*
* Returns @c getline(s,n,widen(&apos;\n&apos;)).
* Returns @c getline(s,n,widen(&apos;\\n&apos;)).
*/
__istream_type&
getline(char_type* __s, streamsize __n)

View File

@ -135,9 +135,11 @@ namespace regex_constants
* Specifies that the grammar recognized by the regular expression engine is
* that used by POSIX utility awk in IEEE Std 1003.1-2001. This option is
* identical to syntax_option_type extended, except that C-style escape
* sequences are supported. These sequences are, explicitly, '\\', '\a',
* '\b', '\f', '\n', '\r', '\t' , '\v', '\'', ''',
* and '\ddd' (where ddd is one, two, or three octal digits).
* sequences are supported. These sequences are:
* \\\\, \\a, \\b, \\f,
* \\n, \\r, \\t , \\v,
* \\&apos;, &apos;, and \\ddd
* (where ddd is one, two, or three octal digits).
*/
static const syntax_option_type awk = 1 << _S_awk;
@ -202,26 +204,26 @@ namespace regex_constants
/**
* The first character in the sequence [first, last) is treated as though it
* is not at the beginning of a line, so the character '^' in the regular
* is not at the beginning of a line, so the character (^) in the regular
* expression shall not match [first, first).
*/
static const match_flag_type match_not_bol = 1 << _S_not_bol;
/**
* The last character in the sequence [first, last) is treated as though it
* is not at the end of a line, so the character '$' in the regular
* is not at the end of a line, so the character ($) in the regular
* expression shall not match [last, last).
*/
static const match_flag_type match_not_eol = 1 << _S_not_eol;
/**
* The expression '\b' is not matched against the sub-sequence
* The expression \\b is not matched against the sub-sequence
* [first,first).
*/
static const match_flag_type match_not_bow = 1 << _S_not_bow;
/**
* The expression '\b' should not be matched against the sub-sequence
* The expression \\b should not be matched against the sub-sequence
* [last,last).
*/
static const match_flag_type match_not_eow = 1 << _S_not_eow;
@ -363,7 +365,7 @@ namespace regex_constants
static const error_type error_space(_S_error_space);
/**
* One of '*?+{' was not preceded by a valid regular expression.
* One of <em>*?+{</em> was not preceded by a valid regular expression.
*/
static const error_type error_badrepeat(_S_error_badrepeat);
@ -2532,7 +2534,7 @@ namespace regex_constants
// [7.12.2] Class template regex_token_iterator
/**
* Iterates over submatches in a range (or 'splits' a text string).
* Iterates over submatches in a range (or @a splits a text string).
*
* The purpose of this iterator is to enumerate all, or all specified,
* matches of a regular expression within a text range. The dereferenced