From: Wolfgang Bangerth Date: Wed, 5 Apr 2017 14:26:10 +0000 (-0600) Subject: Minor updates to the documentation of a couple of classes. X-Git-Tag: v9.0.0-rc1~1745^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F4184%2Fhead;p=dealii.git Minor updates to the documentation of a couple of classes. --- diff --git a/include/deal.II/fe/fe_poly.h b/include/deal.II/fe/fe_poly.h index a20f52aa44..433dc4600a 100644 --- a/include/deal.II/fe/fe_poly.h +++ b/include/deal.II/fe/fe_poly.h @@ -1,6 +1,6 @@ // --------------------------------------------------------------------- // -// Copyright (C) 2004 - 2016 by the deal.II authors +// Copyright (C) 2004 - 2017 by the deal.II authors // // This file is part of the deal.II library. // @@ -30,11 +30,11 @@ DEAL_II_NAMESPACE_OPEN * FiniteElement classes based on polynomial spaces like the * TensorProductPolynomials or PolynomialSpace classes. * - * Every class conforming to the following interface can be used as template - * parameter PolynomialType. + * Every class that has the following public member variables and + * functions can be used as template parameter @p PolynomialType. * * @code - * static const unsigned int dimension; + * static const unsigned int dimension; * * void compute (const Point &unit_point, * std::vector &values, @@ -43,8 +43,8 @@ DEAL_II_NAMESPACE_OPEN * std::vector > &third_derivatives, * std::vector > &fourth_derivatives) const; * - * double compute_value (const unsigned int i, - * const Point &p) const; + * double compute_value (const unsigned int i, + * const Point &p) const; * * template * Tensor compute_derivative (const unsigned int i, diff --git a/include/deal.II/fe/fe_q_base.h b/include/deal.II/fe/fe_q_base.h index 2a39e81e90..67fa80e4a6 100644 --- a/include/deal.II/fe/fe_q_base.h +++ b/include/deal.II/fe/fe_q_base.h @@ -1,6 +1,6 @@ // --------------------------------------------------------------------- // -// Copyright (C) 2000 - 2016 by the deal.II authors +// Copyright (C) 2000 - 2017 by the deal.II authors // // This file is part of the deal.II library. // @@ -29,7 +29,7 @@ DEAL_II_NAMESPACE_OPEN /** * This class collects the basic methods used in FE_Q, FE_Q_DG0 and * FE_Q_Bubbles. There is no public constructor for this class as it is not - * functional as a stand- alone. The completion of definitions is left to the + * functional as a stand-alone. The completion of definitions is left to the * derived classes. * * @author Wolfgang Bangerth, 1998, 2003; Guido Kanschat, 2001; Ralf Hartmann,