]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Prefer code to verbatim environments.
authorDavid Wells <wellsd2@rpi.edu>
Wed, 20 Jan 2016 20:45:26 +0000 (15:45 -0500)
committerDavid Wells <wellsd2@rpi.edu>
Wed, 20 Jan 2016 20:45:26 +0000 (15:45 -0500)
The pair '@code' and '@endcode' will instruct doxygen to perform syntax
highlighting while the verbatim environment does not.

include/deal.II/grid/intergrid_map.h

index 08ef259ec4badf872e1f8381cea733beee260333..bbe640592d9bbf0230d64b51b526edaf11c42141 100644 (file)
@@ -80,7 +80,7 @@ DEAL_II_NAMESPACE_OPEN
  * <h3>Usage</h3>
  *
  * In practice, use of this class is as follows:
- * @verbatim
+ * @code
  *   // have two grids, which are derived from the same coarse grid
  *   Triangulation<dim> tria1, tria2;
  *   DoFHandler<dim> dof_handler_1(tria1), dof_handler_2(tria2);
@@ -97,9 +97,9 @@ DEAL_II_NAMESPACE_OPEN
  *                                           endc = dof_handler_1.end();
  *   for (; cell!=endc; ++cell)
  *     // now do something with the cell of dof_handler_2 corresponding to
- *     // @p cell (which is one of dof_handler_1's cells)
+ *     // cell (which is one of dof_handler_1's cells)
  *     f( grid_1_to_2_map[cell]);
- * @endverbatim
+ * @endcode
  *
  * Note that the template parameters to this class have to be given as
  * <tt>InterGridMap<DoFHandler<2> ></tt>, which here is DoFHandler (and could

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.