From c03100c326c7b3f30b2ad5fe26f804804e315967 Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Sun, 24 Feb 2008 16:12:13 +0000 Subject: [PATCH] added few DON'Ts git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52038 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/tech/tn0003.txt | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/tech/tn0003.txt b/docs/tech/tn0003.txt index 4428be7db0..7db17a5dc4 100644 --- a/docs/tech/tn0003.txt +++ b/docs/tech/tn0003.txt @@ -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 ..., ..., ... + 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 =================================