]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Small updates.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Thu, 10 Mar 2005 21:20:31 +0000 (21:20 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Thu, 10 Mar 2005 21:20:31 +0000 (21:20 +0000)
git-svn-id: https://svn.dealii.org/trunk@10085 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/doc/development/toc.html
deal.II/doc/development/writing-documentation.html

index 86d3d69c647f5cf80f6602b5b38c328e65e5e328..4da78368ebbca6156e59a8d26ede89f426833995 100644 (file)
@@ -15,7 +15,8 @@
     Apart from the online API references and the tutorial, which is
     covered elsewhere, this page gathers some information that might
     be of interest if you want to develop programs based on
-    <acronym>deal.II</acronym> yourself.
+    <acronym>deal.II</acronym> yourself, or if you want to contribute
+    to the development of <acronym>deal.II</acronym> itself.
     </p>
 
     <p>
          see the <a href="../readme.html" target="body">ReadMe</a>
          file for more information on supported systems and porting.
         </p>
+  </ul>
 
+  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:
+  <ul>
     <li> <p><a href="recent-changes.html" target="body">Recent changes to
          the library</a>: 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.
         </p>
 
     <li> <p><a
          href="http://www.dealii.org/cgi-bin/show_regression.pl"
          target="body">Results of regression tests:</a> 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.
         </p>
 
     <li> <p><a
@@ -71,8 +76,7 @@
          target="body">Results of build tests:</a> 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.
         </p>
     </ul>
 
index 859e2e089770394e8305b3b91987eb8bf73ef354..d74f6469ebaac8a6d177cd152914d077d4277a66 100644 (file)
     <p>
     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 <a href="http://www.doxygen.org/"
+    target="_top">doxygen webpage</a> to get an overview. However,
+    here is a brief summary of the most often used features:
     </p>
     <ul> <li> <em>Itemized lists:</em>
         By writing comments like the following,
     </p>
 
     <p>
-    In the future, it would certainly help if the scripts understood
-    something like a <code>title</code> or <code>section</code> 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.
     </p>
 
     <h4>Code examples for the usage of single classes</h4>
     <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>.
+    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.
+    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>
     <hr>
     

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.