This is the mail archive of the
libstdc++@gcc.gnu.org
mailing list for the libstdc++ project.
Doxygen tweaks for TR1 special functions.
- From: Ed Smith-Rowland <3dw4rd at verizon dot net>
- To: libstdc++ <libstdc++ at gcc dot gnu dot org>
- Date: Sat, 16 Feb 2008 09:06:56 -0500
- Subject: Doxygen tweaks for TR1 special functions.
A while back I posted a patch for tweaks to the TR1 special functions
that mixed Doxygen with a branch point fix (slight enhancement) and
constification (possibly over-zealous) in the beta function.
Here is the patch with just the Doxygen bits. The code can wait until
4.4 and then 4.3.1.
I know it's late but it's docs only.
Thanks,
Ed
Index: gcc/libstdc++-v3/include/tr1/poly_laguerre.tcc
===================================================================
--- gcc/libstdc++-v3/include/tr1/poly_laguerre.tcc (revision 132365)
+++ gcc/libstdc++-v3/include/tr1/poly_laguerre.tcc (working copy)
@@ -286,7 +286,7 @@
/**
* @brief This routine returns the associated Laguerre polynomial
- * of order n, degree m: @f$ L_n^m @f$.
+ * of order n, degree m: @f$ L_n^m(x) @f$.
*
* The associated Laguerre polynomial is defined for integral
* @f$ \alpha = m @f$ by:
@@ -314,7 +314,7 @@
/**
- * @brief This routine returns the associated Laguerre polynomial
+ * @brief This routine returns the Laguerre polynomial
* of order n: @f$ L_n(x) @f$.
*
* The Laguerre polynomial is defined by:
Index: gcc/libstdc++-v3/include/tr1/exp_integral.tcc
===================================================================
--- gcc/libstdc++-v3/include/tr1/exp_integral.tcc (revision 132365)
+++ gcc/libstdc++-v3/include/tr1/exp_integral.tcc (working copy)
@@ -509,7 +509,7 @@
/**
- * The exponential integral @f$ Ei(x) @f$.
+ * @brief Return the exponential integral @f$ Ei(x) @f$.
*
* The exponential integral is given by
* \f[
Index: gcc/libstdc++-v3/include/tr1/gamma.tcc
===================================================================
--- gcc/libstdc++-v3/include/tr1/gamma.tcc (revision 132365)
+++ gcc/libstdc++-v3/include/tr1/gamma.tcc (working copy)
@@ -383,7 +383,7 @@
* @brief Return the digamma function for large argument.
* The digamma or @f$ \psi(x) @f$ function is defined by
* @f[
- * \psi(x) = \frac{Gamma'(x)}{\Gamma(x)}
+ * \psi(x) = \frac{\Gamma'(x)}{\Gamma(x)}
* @f]
*
* The asymptotic series is given by:
@@ -416,7 +416,7 @@
* @brief Return the digamma function.
* The digamma or @f$ \psi(x) @f$ function is defined by
* @f[
- * \psi(x) = \frac{Gamma'(x)}{\Gamma(x)}
+ * \psi(x) = \frac{\Gamma'(x)}{\Gamma(x)}
* @f]
* For negative argument the reflection formula is used:
* @f[
Index: gcc/libstdc++-v3/include/tr1/hypergeometric.tcc
===================================================================
--- gcc/libstdc++-v3/include/tr1/hypergeometric.tcc (revision 132365)
+++ gcc/libstdc++-v3/include/tr1/hypergeometric.tcc (working copy)
@@ -714,7 +714,7 @@
}
- /*
+ /**
* @brief Return the hypogeometric function @f$ _2F_1(a,b;c;x) @f$.
*
* The hypogeometric function is defined by