]> https://gitweb.dealii.org/ - dealii.git/commitdiff
doc: fixes for h4 output 7190/head
authorTimo Heister <timo.heister@gmail.com>
Fri, 14 Sep 2018 19:12:01 +0000 (15:12 -0400)
committerTimo Heister <timo.heister@gmail.com>
Fri, 14 Sep 2018 19:12:01 +0000 (15:12 -0400)
include/deal.II/base/data_out_base.h

index 49f96fa1eaf7e6c7d15aa7198705895dfa05f3a5..8b9fa93e5278515faaba627239c3e946d9155f62 100644 (file)
@@ -2584,7 +2584,7 @@ namespace DataOutBase
     std::ostream &                   out);
 
   /**
-   * Write the data in data_filter to a single HDF5 file containing both the
+   * Write the data in @p data_filter to a single HDF5 file containing both the
    * mesh and solution values.
    */
   template <int dim, int spacedim>
@@ -2595,9 +2595,9 @@ namespace DataOutBase
                       MPI_Comm                                 comm);
 
   /**
-   * Write the data in data_filter to HDF5 file(s). If write_mesh_file is
+   * Write the data in @p data_filter to HDF5 file(s). If @p write_mesh_file is
    * false, the mesh data will not be written and the solution file will
-   * contain only the solution values. If write_mesh_file is true and the
+   * contain only the solution values. If @p write_mesh_file is true and the
    * filenames are the same, the resulting file will contain both mesh data
    * and solution values.
    */
@@ -3051,7 +3051,7 @@ public:
    * DataOutFilter:
    *
    * @code
-   * DataOutBase::DataOutFilterFlags flags(true, true)
+   * DataOutBase::DataOutFilterFlags flags(true, true);
    * DataOutBase::DataOutFilter data_filter(flags);
    * std::vector<XDMFEntry> xdmf_entries;
    * // Filter the data and store it in data_filter
@@ -3075,12 +3075,12 @@ public:
                   MPI_Comm                      comm) const;
 
   /**
-   * Write the data in data_filter to a single HDF5 file containing both the
+   * Write the data in @p data_filter to a single HDF5 file containing both the
    * mesh and solution values. Below is an example of how to use this function
    * with the DataOutFilter:
    *
    * @code
-   * DataOutBase::DataOutFilterFlags flags(true, true)
+   * DataOutBase::DataOutFilterFlags flags(true, true);
    * DataOutBase::DataOutFilter data_filter(flags);
    * // Filter the data and store it in data_filter
    * data_out.write_filtered_data(data_filter);

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.