]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix some erroneous uses of @tparam. 1731/head
authorDavid Wells <wellsd2@rpi.edu>
Thu, 8 Oct 2015 19:30:25 +0000 (15:30 -0400)
committerDavid Wells <wellsd2@rpi.edu>
Thu, 8 Oct 2015 22:04:04 +0000 (18:04 -0400)
@tparam, unlike @param, starts a new paragraph where it is used. This
causes some strangely formatted documentation.

include/deal.II/base/polynomial_space.h
include/deal.II/base/table_indices.h
include/deal.II/base/tensor.h
include/deal.II/base/tensor_product_polynomials.h
include/deal.II/base/tensor_product_polynomials_const.h

index 9c73f2d1f40a4c866f822fd2bd0ce3d49678e2a4..8853bf40d86c0e6e6a479db508cfada5c1382a19 100644 (file)
@@ -154,10 +154,12 @@ public:
                         const Point<dim> &p) const;
 
   /**
-   * Computes the order @tparam order derivative of the <tt>i</tt>th
-   * polynomial at unit point <tt>p</tt>.
+   * Computes the <tt>order</tt>th derivative of the <tt>i</tt>th polynomial
+   * at unit point <tt>p</tt>.
    *
    * Consider using compute() instead.
+   *
+   * @tparam order The order of the derivative.
    */
   template <int order>
   Tensor<order,dim> compute_derivative (const unsigned int i,
index 62dabf1de9cb670f45bbcda5a9ecf130bd57c142..573b380fafb65d8524a41aea7b871d54e2e3623b 100644 (file)
@@ -52,11 +52,13 @@ public:
    * to populate a TableIndices object upon creation, either completely, or
    * partially.
    *
-   * Index entries that are not set by this 1 - 9 arguments (either
-   * because they are omitted, or because @tparam N is larger than 9) are
-   * set to numbers::invalid_unsigned_int.
+   * Index entries that are not set by these arguments (either because
+   * they are omitted, or because $N > 9$) are set to
+   * numbers::invalid_unsigned_int.
    *
-   * Note that only the first @tparam N arguments are actually used.
+   * Note that only the first <tt>N</tt> arguments are actually used.
+   *
+   * @tparam N The number of indices stored in each object.
    */
   TableIndices (const unsigned int index0,
                 const unsigned int index1 = numbers::invalid_unsigned_int,
index b59c1f1c955c318a9ce449bd0ea450a8b3bb7998..e0a3b0ce135d5b5d5eb6417fcae3735f4442a282 100644 (file)
@@ -1394,7 +1394,9 @@ operator / (const Tensor<rank,dim,Number> &t,
 
 
 /**
- * Addition of two tensors of general @tparam rank.
+ * Addition of two tensors of general rank.
+ *
+ * @tparam rank The rank of both tensors.
  *
  * @relates Tensor
  */
@@ -1413,7 +1415,9 @@ operator+ (const Tensor<rank,dim,Number> &p, const Tensor<rank,dim,OtherNumber>
 
 
 /**
- * Subtraction of two tensors of general @tparam rank.
+ * Subtraction of two tensors of general rank.
+ *
+ * @tparam rank The rank of both tensors.
  *
  * @relates Tensor
  */
index 6cc9c3bedce71da6b4a0458e409817332e2711c7..8f71e53ae1173e1001e345f022a181ad7b070931 100644 (file)
@@ -135,7 +135,7 @@ public:
                         const Point<dim> &p) const;
 
   /**
-   * Computes the order @tparam order derivative of the <tt>i</tt>th tensor
+   * Computes the <tt>order</tt>th derivative of the <tt>i</tt>th tensor
    * product polynomial at <tt>unit_point</tt>. Here <tt>i</tt> is given in
    * tensor product numbering.
    *
@@ -145,6 +145,8 @@ public:
    * several times.  Instead use the compute() function, see above, with
    * the size of the appropriate parameter set to n() to get the point value
    * of all tensor polynomials all at once and in a much more efficient way.
+   *
+   * @tparam order The derivative order.
    */
   template <int order>
   Tensor<order,dim> compute_derivative (const unsigned int i,
@@ -288,7 +290,7 @@ public:
                         const Point<dim> &p) const;
 
   /**
-   * Computes the order @tparam order derivative of the <tt>i</tt>th tensor
+   * Computes the <tt>order</tt>th derivative of the <tt>i</tt>th tensor
    * product polynomial at <tt>unit_point</tt>. Here <tt>i</tt> is given in
    * tensor product numbering.
    *
@@ -298,6 +300,8 @@ public:
    * several times.  Instead use the compute() function, see above, with
    * the size of the appropriate parameter set to n() to get the point value
    * of all tensor polynomials all at once and in a much more efficient way.
+   *
+   * @tparam order The derivative order.
    */
   template <int order>
   Tensor<order,dim> compute_derivative (const unsigned int i,
index 9bfa94bc72578f4c76e5b7ff2435e5b0c4b62393..d0441b05b2bfd87f339763176827471c89e78980 100644 (file)
@@ -96,7 +96,7 @@ public:
                         const Point<dim> &p) const;
 
   /**
-   * Computes the order @tparam order derivative of the <tt>i</tt>th tensor
+   * Computes the <tt>order</tt>th derivative of the <tt>i</tt>th tensor
    * product polynomial at <tt>unit_point</tt>. Here <tt>i</tt> is given in
    * tensor product numbering.
    *
@@ -106,6 +106,8 @@ public:
    * several times.  Instead use the compute() function, see above, with
    * the size of the appropriate parameter set to n() to get the point value
    * of all tensor polynomials all at once and in a much more efficient way.
+   *
+   * @tparam order The derivative order.
    */
   template <int order>
   Tensor<order,dim> compute_derivative (const unsigned int i,

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.