]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Minor updates to the documentation of a couple of classes. 4184/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Wed, 5 Apr 2017 14:26:10 +0000 (08:26 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Wed, 5 Apr 2017 14:26:10 +0000 (08:26 -0600)
include/deal.II/fe/fe_poly.h
include/deal.II/fe/fe_q_base.h

index a20f52aa44175b500365300fb8fabb1d89fb6b54..433dc4600af32975c75b12cbe9933c61621f42fa 100644 (file)
@@ -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<dim>            &unit_point,
  *                std::vector<double>         &values,
@@ -43,8 +43,8 @@ DEAL_II_NAMESPACE_OPEN
  *                std::vector<Tensor<3,dim> > &third_derivatives,
  *                std::vector<Tensor<4,dim> > &fourth_derivatives) const;
  *
- * double compute_value (const unsigned int i,
- *                       const Point<dim> &p) const;
+ *  double compute_value (const unsigned int i,
+ *                        const Point<dim> &p) const;
  *
  *  template <int order>
  *  Tensor<order,dim> compute_derivative (const unsigned int i,
index 2a39e81e90c5775f501a3a594dd88f69bbcb76eb..67fa80e4a6c71103d07c65749fb4dbf3347f3de8 100644 (file)
@@ -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,

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.