From: wolf
@@ -50,20 +51,24 @@ see the ReadMe file for more information on supported systems and porting.
+ + Finally, here are a few pages that are automatically generated. Note + that these references point to a global copy on our web server, not + to in your local directory: +Recent changes to the library: If you want to stay informed about what is - going on with the library itself, your may want to take a - look at the page where we have some information about + going on with the library itself, you may want to take a + look at this page where we have some information about recent changes to the library.
Results of regression tests: Every night, - the regression tests are run on our server. The log of the - results can be seen here. (This reference points to the global - copy, not one in your local directory.) + the regression tests are run on some of our machines. The log of the + results can be seen here.
Results of build tests: We also build the library each night on a variety of computers, using different compilers. The results of these builds is listed as - well. (This reference also points to the global - copy, not one in your local directory.) + well.
In order to allow better structured output for long comments, doxygen supports a great number of tags for enumerations, - sectioning, markup, and other fields. For example, here is how to - generate + sectioning, markup, and other fields. We encourage you to take a + look at the doxygen webpage to get an overview. However, + here is a brief summary of the most often used features:
- In the future, it would certainly help if the scripts understood
- something like a title
or section
tag
- (preferably something similar to the DocBook SGML commands for
- that) in the comments, which could help to better structure the
- output, especially for the longer programs. One would probably
- like to put a section break before each new function or class, or
- something along these lines.
+ In the future, it would certainly help if the scripts became a
+ little smarter. The only real functionality we presently have
+ beyond converting comments to interspersed text is that they can
+ extract section headings (take a look at step-16 does this), but
+ it would be interesting if one could add formulae, for example, or
+ if the tools could also generate output in a format that would
+ allow for higher quality printing than what we get from HTML.
@include filename
.
+ 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.
+ 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.