From: Wolfgang Bangerth Date: Mon, 27 Nov 2017 20:11:02 +0000 (-0700) Subject: Change grammar of function documentation. X-Git-Tag: v9.0.0-rc1~723^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F5540%2Fhead;p=dealii.git Change grammar of function documentation. --- diff --git a/include/deal.II/base/polynomial.h b/include/deal.II/base/polynomial.h index dc0c35c21c..ce5fd6772d 100644 --- a/include/deal.II/base/polynomial.h +++ b/include/deal.II/base/polynomial.h @@ -233,7 +233,7 @@ namespace Polynomials const number factor); /** - * Transforms polynomial form of product of linear factors into standard + * Transform polynomial form of product of linear factors into standard * form, $\sum_i a_i x^i$. Deletes all data structures related to the * product form. */ diff --git a/include/deal.II/fe/mapping.h b/include/deal.II/fe/mapping.h index c23c772dfc..3b8ef0b3d3 100644 --- a/include/deal.II/fe/mapping.h +++ b/include/deal.II/fe/mapping.h @@ -392,7 +392,7 @@ public: const Point &p) const = 0; /** - * Transforms the point @p p on the real @p cell to the corresponding point + * Transform the point @p p on the real @p cell to the corresponding point * on the unit cell, and then projects it to a dim-1 point on the face with * the given face number @p face_no. Ideally the point @p p is near the face * @p face_no, but any point in the cell can technically be projected. diff --git a/include/deal.II/fe/mapping_fe_field.h b/include/deal.II/fe/mapping_fe_field.h index 43993b4f2b..16787db37b 100644 --- a/include/deal.II/fe/mapping_fe_field.h +++ b/include/deal.II/fe/mapping_fe_field.h @@ -511,7 +511,7 @@ private: private: /** - * Transforms a point @p p on the unit cell to the point @p p_real on the + * Transform a point @p p on the unit cell to the point @p p_real on the * real cell @p cell and returns @p p_real. * * This function is called by @p transform_unit_to_real_cell and multiple @@ -530,7 +530,7 @@ private: /** - * Transforms the point @p p on the real cell to the corresponding point on + * Transform the point @p p on the real cell to the corresponding point on * the unit cell @p cell by a Newton iteration. * * Takes a reference to an @p InternalData that is assumed to be previously diff --git a/include/deal.II/fe/mapping_q.h b/include/deal.II/fe/mapping_q.h index 783be0edf8..c115f1e88d 100644 --- a/include/deal.II/fe/mapping_q.h +++ b/include/deal.II/fe/mapping_q.h @@ -121,7 +121,7 @@ public: bool preserves_vertex_locations () const; /** - * Transforms the point @p p on the unit cell to the point @p p_real on the + * Transform the point @p p on the unit cell to the point @p p_real on the * real cell @p cell and returns @p p_real. */ virtual @@ -131,7 +131,7 @@ public: const Point &p) const; /** - * Transforms the point @p p on the real cell to the point @p p_unit on the + * Transform the point @p p on the real cell to the point @p p_unit on the * unit cell @p cell and returns @p p_unit. * * Uses Newton iteration and the @p transform_unit_to_real_cell function. diff --git a/include/deal.II/fe/mapping_q_generic.h b/include/deal.II/fe/mapping_q_generic.h index 6b8af95b28..7a5e14129e 100644 --- a/include/deal.II/fe/mapping_q_generic.h +++ b/include/deal.II/fe/mapping_q_generic.h @@ -683,7 +683,7 @@ protected: compute_mapping_support_points (const typename Triangulation::cell_iterator &cell) const; /** - * Transforms the point @p p on the real cell to the corresponding point on + * Transform the point @p p on the real cell to the corresponding point on * the unit cell @p cell by a Newton iteration. */ Point