From: prill Date: Mon, 6 Nov 2006 07:34:44 +0000 (+0000) Subject: Added doxygen documentation for QGaussLobatto class. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a60a43375f8374328ede2505c927e4bb3468d8ca;p=dealii-svn.git Added doxygen documentation for QGaussLobatto class. git-svn-id: https://svn.dealii.org/trunk@14165 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/base/include/base/quadrature_lib.h b/deal.II/base/include/base/quadrature_lib.h index a1362d1078..6e2111e0b6 100644 --- a/deal.II/base/include/base/quadrature_lib.h +++ b/deal.II/base/include/base/quadrature_lib.h @@ -85,7 +85,10 @@ class QGaussLobatto : public Quadrature protected: /** * Compute Legendre-Gauss-Lobatto quadrature - * points in the interval [-1, +1]. + * points in the interval [-1, +1] which are + * equal to the roots of the corresponding + * Jacobi polynomial (specified by + * @p alpha, @p beta). * @param q number of points. * @return vector containing nodes. */ @@ -97,6 +100,9 @@ class QGaussLobatto : public Quadrature /** * Compute Legendre-Gauss-Lobatto quadrature * weights. + * The quadrature points and weights are + * related to Jacobi polynomial specified + * by @p alpha, @p beta. * @param x quadrature points. * @return vector containing weights. */ @@ -107,7 +113,9 @@ class QGaussLobatto : public Quadrature /** * Evaluate a Jacobi polynomial - * $ P^{\alpha, \beta}_n(x) $. + * $ P^{\alpha, \beta}_n(x) $ + * specified by the parameters + * @p alpha, @p beta, @p n. * Note: The Jacobi polynomials are * not orthonormal and defined on * the interval [-1, +1].