]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update UpdateFlags documentation 1464/head
authorDavid Wells <wellsd2@rpi.edu>
Sat, 29 Aug 2015 21:48:50 +0000 (17:48 -0400)
committerDavid Wells <wellsd2@rpi.edu>
Sat, 29 Aug 2015 21:48:50 +0000 (17:48 -0400)
The '@deprecation' attribute creates a new block, so descriptions of
deprecated features should be complete sentences.

I also added additional hover text descriptions.

include/deal.II/fe/fe_update_flags.h

index 5a93350decac68c4c177bed7e519e1289d3a5649..7f37418263fb0609fad2ba76b212377a11687c0f 100644 (file)
@@ -138,11 +138,11 @@ enum UpdateFlags
    */
   update_normal_vectors = 0x0040,
   /**
-   * @deprecated Use #update_normal_vectors
+   * @deprecated Use #update_normal_vectors instead.
    */
   update_face_normal_vectors = update_normal_vectors,
   /**
-   * @deprecated Use #update_normal_vectors
+   * @deprecated Use #update_normal_vectors instead.
    */
   update_cell_normal_vectors = update_normal_vectors,
   //! Volume element
@@ -194,23 +194,25 @@ enum UpdateFlags
    */
   update_volume_elements = 0x4000,
   /**
-   * @deprecated: this flag has no effect.
+   * @deprecated This flag has no effect.
    */
   update_support_points = 0x10000,
+  //! Jacobian at generalized support points
   /**
    * Update the Jacobian of the mapping in generalized support points.
    */
   update_support_jacobians = 0x20000,
+  //! inverse Jacobian at generalized support points
   /**
    * Update the inverse Jacobian of the mapping in generalized support points.
    */
   update_support_inverse_jacobians = 0x40000,
   /**
-   * @deprecated Update quadrature points
+   * @deprecated Use #update_quadrature_points instead.
    */
   update_q_points = update_quadrature_points,
   /**
-   * @deprecated Update second derivatives.
+   * @deprecated Use #update_hessians instead.
    */
   update_second_derivatives = update_hessians,
   //! Values needed for Piola transform

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.