added more instruction for writing the docs

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@12726 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2001-11-27 14:44:40 +00:00
parent 1d8c3e58b8
commit 408a83cbe9

View File

@@ -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 that several overloaded forms of the same member function are
documented within the same \membersection. 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}