X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5d4cca7f4bcbead614819eaa8d79e0edee24b70c..57b2bba406d9fd2464220281b1313652b883af89:/docs/doxygen/Doxyfile_inc diff --git a/docs/doxygen/Doxyfile_inc b/docs/doxygen/Doxyfile_inc index 1225dad032..148a34d1c5 100644 --- a/docs/doxygen/Doxyfile_inc +++ b/docs/doxygen/Doxyfile_inc @@ -167,12 +167,14 @@ ALIASES += endWxPythonOnly="\endif" ALIASES += leftCurly="{" ALIASES += rightCurly="}" +# Sample documentation related aliases # For indicating the a directory containing a sample ALIASES += sampledir{1}="\verbatim Location: samples/\1\endverbatim" -# For refering to a sample introduction in a class document or a overview +# 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 by associating it with a class +# 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