From: Francesco Montorsi Date: Tue, 30 Dec 2008 18:19:49 +0000 (+0000) Subject: no real change; make more readable the Aliases section X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/94802614d1bfc0e94b73176fd1420690fb2f54d8 no real change; make more readable the Aliases section git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57673 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/doxygen/Doxyfile_inc b/docs/doxygen/Doxyfile_inc index 7a1be90942..fbc6af0da6 100644 --- a/docs/doxygen/Doxyfile_inc +++ b/docs/doxygen/Doxyfile_inc @@ -40,13 +40,13 @@ CPP_CLI_SUPPORT = NO DISTRIBUTE_GROUP_DOC = YES SUBGROUPING = YES +# This is the most important part of the wxWidgets Doxyfile; aliases allow +# us to keep the headers readable and "implement" wxWidgets-specific commands: + #--------------------------------------------------------------------------- -# Aliases +# Aliases - for use when documenting C++ classes #--------------------------------------------------------------------------- -# This is the most important part of the wxWidgets Doxyfile; aliases allow -# us to keep the headers readable and "implement" wxWidgets-specific commands. - # event aliases ALIASES = beginEventTable{1}="\nEvents:

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(\1& event)

Event macros:
" ALIASES += beginEventTable{2}="\nEvents:

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(\1& event) or void handlerFuncName(\2& event)

Event macros:
" @@ -70,6 +70,13 @@ ALIASES += beginFlagTable="
" ALIASES += flag{1}="
\li \1:
" ALIASES += endFlagTable="
\n" +# creates appearance section: this should be used for all main GUI controls +ALIASES += appearance{1}="\htmlonly
Appearance:
wxMSW appearancewxGTK appearancewxMac appearance
wxMSW appearancewxGTK appearancewxMac appearance
\endhtmlonly" + +#--------------------------------------------------------------------------- +# Aliases - for use when documenting any C++ entity +#--------------------------------------------------------------------------- + # aliases for additional wx-specific infos ALIASES += category{1}="\ingroup group_class_\1 \n
Category:  \ref group_class_\1
" ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \n
Category:  \ref group_class_\1, \ref group_class_\2
" @@ -91,9 +98,6 @@ ALIASES += onlyfor{2}="
Availability:   ALIASES += onlyfor{3}="
Availability:  only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports.
\xmlonly \1,\2,\3 \endxmlonly" ALIASES += onlyfor{4}="
Availability:  only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports.
\xmlonly \1,\2,\3,\4 \endxmlonly" -# creates appearance section: this should be used for all main GUI controls -ALIASES += appearance{1}="\htmlonly
Appearance:
wxMSW appearancewxGTK appearancewxMac appearance
wxMSW appearancewxGTK appearancewxMac appearance
\endhtmlonly" - # Use this in grouped global functions, and macros since they # wouldn't otherwise indicate what header they are defined in. ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim" @@ -155,6 +159,10 @@ ALIASES += itemdef{10}="\1 \2,\3,\ ALIASES += endDefList="" ALIASES += stock{3}="\1 @image html gtk-\2.png\n\3" +#--------------------------------------------------------------------------- +# Aliases - for use when documenting wxPerl/wxPython-specific parts +#--------------------------------------------------------------------------- + # See ENABLED_SECTIONS configuration key for more info about these: ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL wxPerl Note: " ALIASES += endWxPerlOnly="\endif" @@ -166,16 +174,22 @@ ALIASES += endWxPythonOnly="\endif" ALIASES += leftCurly="{" ALIASES += rightCurly="}" -# Sample documentation related aliases +#--------------------------------------------------------------------------- +# Aliases - for use when documenting samples +#--------------------------------------------------------------------------- + # For indicating the a directory containing a sample ALIASES += sampledir{1}="\verbatim Location: samples/\1\endverbatim" + # For refering to the corresponding sample in a class document or a overview # Usually placed in the queue of @see ALIASES += sample{1}="\ref page_samples_\1" + # For generating a general description for a sample # \1 could be a class or an overview or a descriptive sentence # Shall be replaced by manual written description soon ALIASES += sampleabout{1}="This sample demonstrates \1." + # For indicating the necessary condition of a sample or a class # \1 is the wxUSE_XXX macro ALIASES += buildwith{1}="Build Note: You may need to build the wxWidgets library with \1 being set to 1 to be able to make it work, please read comments in @c for more info."