From: Wolfgang Bangerth Date: Thu, 12 Sep 2024 18:56:42 +0000 (-0600) Subject: Remove a section about ways to use doxygen that we don't use. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F17698%2Fhead;p=dealii.git Remove a section about ways to use doxygen that we don't use. --- diff --git a/doc/developers/writing-documentation.html b/doc/developers/writing-documentation.html index 83d9df1cc6..40d4777c16 100644 --- a/doc/developers/writing-documentation.html +++ b/doc/developers/writing-documentation.html @@ -238,26 +238,6 @@ void foobar () -

Code examples for the usage of single classes

-

- Writing example files for classes is supported by - doxygen. These example files go into - deal.II/examples/doxygen. If they are short, - documentation should be inside and they are included into the - documentation with @include filename. Take a look how - the class BlockMatrixArray does this. -

- -

- Larger example files should be documented using the - doxygen command @dotinclude 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 - step-XX series. -

- -

Writing example programs for the tutorial