]> git.saurik.com Git - wxWidgets.git/commitdiff
added few DON'Ts
authorFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Sun, 24 Feb 2008 16:12:13 +0000 (16:12 +0000)
committerFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Sun, 24 Feb 2008 16:12:13 +0000 (16:12 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52038 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/tech/tn0003.txt

index 4428be7db0d86c833870902dc0ae0818cccca25a..7db17a5dc4579ae77df3e79913b64938fe10bf11 100644 (file)
@@ -96,6 +96,15 @@ DON'T:
 
 - use non-alphanumeric characters in link anchors.
 
+- use Doxygen @b @c @e commands when referring to more than a single word;
+  in that case you need to use the <b>...</b>, <tt>...</tt>, <em>...</em>
+  HTML-style tags instead
+
+- use HTML style tags for creation of tables or lists.
+  Use wx aliases instead like @beginTable, @row2col, @row3col, @endTable and
+  @beginDefList, @itemdef, @endDefList, etc.
+  See the Doxyfile for more info.
+
 
 Documentation comment for a class
 =================================