</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>