]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Improve some documentation in ADHelper classes.
authorJean-Paul Pelteret <jppelteret@gmail.com>
Thu, 6 Dec 2018 13:41:52 +0000 (14:41 +0100)
committerJean-Paul Pelteret <jppelteret@gmail.com>
Thu, 24 Jan 2019 07:44:11 +0000 (08:44 +0100)
include/deal.II/differentiation/ad/ad_helpers.h

index 4d8bcc78a32546e4fa171dbf70ad327b57b94199..c8bd16a31b7d1270d914ccca038123e953296cad 100644 (file)
@@ -949,7 +949,7 @@ namespace Differentiation
        * Depending on the selected @p ADNumberTypeCode, this may or may not
        * correspond with the @p ScalarType prescribed as a template argument.
        *
-       * @note If the keep flag has been set when
+       * @note If the @p keep_independent_values flag has been set when
        * ADHelperBase::start_recording_operations() is called then the tape is
        * immediately usable after creation, and the values of the independent
        * variables set by register_dof_values() are those at which the function
@@ -969,7 +969,7 @@ namespace Differentiation
        * which to extract the local degree of freedom values. This would
        * typically obtained by calling <code>cell->get_dof_indices()</code>.
        *
-       * @note If the keep flag has been set when
+       * @note If the @p keep_independent_values flag has been set when
        * ADHelperBase::start_recording_operations() is called then the tape is
        * immediately usable after creation, and the values of the independent
        * variables set by register_dof_values() are those at which the function

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.