]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/tech/tn0003.txt
fix tree icon refresh after collapsing a branch (patch 565294)
[wxWidgets.git] / docs / tech / tn0003.txt
index e193c50fe1b17dcf764ca7d3d3b1ced4d43210f8..738a1b7d460791d0e56fa2a3c36e5fd7c75c8c7b 100644 (file)
@@ -58,7 +58,7 @@ v2.2.0 of wxWindows to use the -interactive switch
 If you wish to generate documentation for wxHTML Help Viewer
 (or Windows HTML Help), set htmlWorkshopFiles to true in your
 tex2rtf.ini file. See also the wxHTML Notes section in the
-wxWindows manual. To futher speed-up HTML help books loading
+wxWindows manual. To further speed-up HTML help books loading
 in your application, you may use hhp2cached (utils/hhp2cached).
 
 src/msw/makefile.vc contains targets for generating various
@@ -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.
 
+
+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}
+