added more instruction for writing the docs

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@12726 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/tech/tn0003.txt b/docs/tech/tn0003.txt
index e193c50fe1b17dcf764ca7d3d3b1ced4d43210f8..8965f44405c73df5e7d6ef8f6c939d69a1a00ca2 100644 (file)
--- a/docs/tech/tn0003.txt
+++ b/docs/tech/tn0003.txt
@@ -253,3 +253,18 @@ Note the use of \docparam to document parameters; and the fact
 that several overloaded forms of the same member function are
 documented within the same \membersection.
 
 that several overloaded forms of the same member function are
 documented within the same \membersection.
 

+
+Special forms:
+
+- for a const member function use \constfunc{} instead of \const
+
+- for a function without parameters use \func{...}{Function}{\void}
+
+- but do NOT use \void for functions without return value, just "void"
+
+- for a virtual/static member function use \func{virtual/static ...}
+
+- omit the return type for constructors: \func{}{MyClass}{...}
+
+- use \destruct macro for the destructors \func{}{\destruct{MyClass}}{\void}
+