This is the mail archive of the
gcc-patches@gcc.gnu.org
mailing list for the GCC project.
[v3] doxygen random fixes
- From: Benjamin Kosnik <bkoz at redhat dot com>
- To: gcc-patches at gcc dot gnu dot org, libstdc++ at gcc dot gnu dot org
- Date: Tue, 23 Feb 2010 16:07:51 -0800
- Subject: [v3] doxygen random fixes
Puts the random group back into the top-level numerics grouping,
displaced post 4.4.
tested x86_64/linux
-benjamin
2010-02-23 Benjamin Kosnik <bkoz@redhat.com>
* include/bits/random.h: Doxygen group markup fixes.
Index: include/bits/random.h
===================================================================
--- include/bits/random.h (revision 157022)
+++ include/bits/random.h (working copy)
@@ -35,7 +35,9 @@
// [26.4] Random number generation
/**
- * @addtogroup std_random Random Number Generation
+ * @defgroup random Random Number Generation
+ * @ingroup numerics
+ *
* A facility for generating random numbers on selected distributions.
* @{
*/
@@ -114,8 +116,8 @@
} // namespace __detail
/**
- * @addtogroup std_random_generators Random Number Generators
- * @ingroup std_random
+ * @addtogroup random_generators Random Number Generators
+ * @ingroup random
*
* These classes define objects which provide random or pseudorandom
* numbers, either from a discrete or a continuous interval. The
@@ -1471,17 +1473,17 @@
#endif
};
- /* @} */ // group std_random_generators
+ /* @} */ // group random_generators
/**
- * @addtogroup std_random_distributions Random Number Distributions
- * @ingroup std_random
+ * @addtogroup random_distributions Random Number Distributions
+ * @ingroup random
* @{
*/
/**
- * @addtogroup std_random_distributions_uniform Uniform Distributions
- * @ingroup std_random_distributions
+ * @addtogroup random_distributions_uniform Uniform Distributions
+ * @ingroup random_distributions
* @{
*/
@@ -1790,11 +1792,11 @@
operator>>(std::basic_istream<_CharT, _Traits>&,
std::uniform_real_distribution<_RealType>&);
- /* @} */ // group std_random_distributions_uniform
+ /* @} */ // group random_distributions_uniform
/**
- * @addtogroup std_random_distributions_normal Normal Distributions
- * @ingroup std_random_distributions
+ * @addtogroup random_distributions_normal Normal Distributions
+ * @ingroup random_distributions
* @{
*/
@@ -2849,11 +2851,11 @@
std::gamma_distribution<result_type> _M_gd;
};
- /* @} */ // group std_random_distributions_normal
+ /* @} */ // group random_distributions_normal
/**
- * @addtogroup std_random_distributions_bernoulli Bernoulli Distributions
- * @ingroup std_random_distributions
+ * @addtogroup random_distributions_bernoulli Bernoulli Distributions
+ * @ingroup random_distributions
* @{
*/
@@ -3472,11 +3474,11 @@
std::gamma_distribution<double> _M_gd;
};
- /* @} */ // group std_random_distributions_bernoulli
+ /* @} */ // group random_distributions_bernoulli
/**
- * @addtogroup std_random_distributions_poisson Poisson Distributions
- * @ingroup std_random_distributions
+ * @addtogroup random_distributions_poisson Poisson Distributions
+ * @ingroup random_distributions
* @{
*/
@@ -4606,13 +4608,13 @@
};
- /* @} */ // group std_random_distributions_poisson
+ /* @} */ // group random_distributions_poisson
- /* @} */ // group std_random_distributions
+ /* @} */ // group random_distributions
/**
- * @addtogroup std_random_utilities Random Number Utilities
- * @ingroup std_random
+ * @addtogroup random_utilities Random Number Utilities
+ * @ingroup random
* @{
*/
@@ -4657,9 +4659,9 @@
std::vector<result_type> _M_v;
};
- /* @} */ // group std_random_utilities
+ /* @} */ // group random_utilities
- /* @} */ // group std_random
+ /* @} */ // group random
}