From: guido
Date: Mon, 23 May 2005 22:17:24 +0000 (+0000)
Subject: style recommendation for virtuals
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=08dbc62559660c1c1667a8a5eeb02c781bd87fa4;p=dealii-svn.git
style recommendation for virtuals
git-svn-id: https://svn.dealii.org/trunk@10706 0785d39b-7218-0410-832d-ea1e28bc413d
---
diff --git a/deal.II/doc/development/writing-documentation.html b/deal.II/doc/development/writing-documentation.html
index 593d7ad7dd..86fcfeec66 100644
--- a/deal.II/doc/development/writing-documentation.html
+++ b/deal.II/doc/development/writing-documentation.html
@@ -117,7 +117,16 @@
target="_top">doxygen webpage to get an overview. However,
here is a brief summary of the most often used features:
- - Itemized lists:
+
+ - Virtual functions:
+ 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.
+
+
- Itemized lists:
By writing comments like the following,
/**