]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
style recommendation for virtuals
authorguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 23 May 2005 22:17:24 +0000 (22:17 +0000)
committerguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 23 May 2005 22:17:24 +0000 (22:17 +0000)
git-svn-id: https://svn.dealii.org/trunk@10706 0785d39b-7218-0410-832d-ea1e28bc413d

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

index 593d7ad7dd10a91a5f0314327f7f09a7de5600ed..86fcfeec66de1d693b6536bff58e6ca5cd47b4d1 100644 (file)
     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>
+    <ul>
+    <li> <em>Virtual functions:</em>
+        Do not document virtual functions in derived classes, if there
+        is nothing different from the base class. If a virtual
+        function is documented in a base class, doxygen will
+        automatically copy this documentation to the derived
+        classes. This mechanism is interrupted, if a documentation
+        block is found in the derived class.
+
+    <li> <em>Itemized lists:</em>
         By writing comments like the following,
         <pre>
           /**

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.