]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Remove a section about ways to use doxygen that we don't use. 17698/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Thu, 12 Sep 2024 18:56:42 +0000 (12:56 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Thu, 12 Sep 2024 18:56:42 +0000 (12:56 -0600)
doc/developers/writing-documentation.html

index 83d9df1cc654dc5fd54ff07bc936f88240d323c9..40d4777c161567efa5496289cec26eb4db90cc7f 100644 (file)
@@ -238,26 +238,6 @@ void foobar ()
 </pre>
     </ul>
 
-    <h3>Code examples for the usage of single classes</h3>
-    <p>
-    Writing example files for classes is supported by
-    <acronym>doxygen</acronym>. These example files go into
-    <tt>deal.II/examples/doxygen</tt>. If they are short,
-    documentation should be inside and they are included into the
-    documentation with <code>@include filename</code>. Take a look how
-    the class <code>BlockMatrixArray</code> does this.
-    </p>
-
-    <p>
-    Larger example files should be documented using the
-    <acronym>doxygen</acronym> command <code>@dotinclude</code> and
-    related commands. However, if these programs do something
-    reasonable and do not only demonstrate a single topic, you should
-    consider converting them to a complete example program in the
-    <code>step-XX</code> series.
-    </p>
-
-
 
     <a name="examples"></a>
     <h2>Writing example programs for the tutorial</h2>

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.