X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5d4cca7f4bcbead614819eaa8d79e0edee24b70c..053ac76fa2b4bd461c88258ab642f7804da88e80:/docs/doxygen/Doxyfile_inc diff --git a/docs/doxygen/Doxyfile_inc b/docs/doxygen/Doxyfile_inc index 1225dad032..968fb9b282 100644 --- a/docs/doxygen/Doxyfile_inc +++ b/docs/doxygen/Doxyfile_inc @@ -7,7 +7,7 @@ ############################################################################# #--------------------------------------------------------------------------- -# Project related configuration options +# Project Options #--------------------------------------------------------------------------- DOXYFILE_ENCODING = UTF-8 @@ -21,9 +21,10 @@ REPEAT_BRIEF = NO ABBREVIATE_BRIEF = ALWAYS_DETAILED_SEC = YES INLINE_INHERITED_MEMB = NO -FULL_PATH_NAMES = NO -STRIP_FROM_PATH = -STRIP_FROM_INC_PATH = +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = "$(WXWIDGETS)/" +STRIP_FROM_INC_PATH = "$(WXWIDGETS)/include/" \ + "$(WXWIDGETS)/interface/" SHORT_NAMES = NO JAVADOC_AUTOBRIEF = NO QT_AUTOBRIEF = NO @@ -92,15 +93,10 @@ ALIASES += onlyfor{4}="
Availability:   # 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" -# IMPORTANT: the \headerfile command does not work everywhere we'd need it, -# e.g. in the constants page we need to specify an header file -# even if they're not inside a \class, \function or \struct command: +# 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" -# IMPORTANT: inside a \class, we want to specify the header file only once -# and not twice as the \headerfile command requires: -ALIASES += wxheader{1}="\headerfile \1 wx/\1" - # some formatting aliases ALIASES += true="true" ALIASES += false="false" @@ -167,12 +163,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 @@ -180,10 +178,10 @@ ALIASES += sampleabout{1}="This sample demonstrates \1." 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." ALIASES += buildwith{2}="Build Note: You may need to build the wxWidgets library with \1 and \2 being set to 1 to be able to make it work, please read comments in @c for more info." - #--------------------------------------------------------------------------- -# Build related configuration options +# Build Options #--------------------------------------------------------------------------- + EXTRACT_ALL = YES EXTRACT_PRIVATE = NO EXTRACT_STATIC = YES @@ -211,14 +209,15 @@ GENERATE_DEPRECATEDLIST= YES ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL MAX_INITIALIZER_LINES = 30 -SHOW_USED_FILES = YES +SHOW_USED_FILES = NO SHOW_DIRECTORIES = YES -#SHOW_FILES = NO # Doxygen 1.5.6+ +SHOW_FILES = YES # Doxygen 1.5.6+ FILE_VERSION_FILTER = #--------------------------------------------------------------------------- -# configuration options related to warning and progress messages +# Warning and Progress Message Options #--------------------------------------------------------------------------- + QUIET = YES WARNINGS = YES WARN_IF_UNDOCUMENTED = YES @@ -228,8 +227,9 @@ WARN_FORMAT = "$file:$line: $text " WARN_LOGFILE = doxygen.log #--------------------------------------------------------------------------- -# configuration options related to the input files +# Input File Options #--------------------------------------------------------------------------- + INPUT = ./mainpages ./groups ./overviews ../../interface INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.h *.txt @@ -247,8 +247,9 @@ FILTER_PATTERNS = FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- -# configuration options related to source browsing +# Source Browsing Options #--------------------------------------------------------------------------- + SOURCE_BROWSER = NO INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES @@ -259,8 +260,9 @@ USE_HTAGS = NO VERBATIM_HEADERS = NO #--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index +# Alphabetical Class Index Options #--------------------------------------------------------------------------- + ALPHABETICAL_INDEX = YES COLS_IN_ALPHA_INDEX = 5 IGNORE_PREFIX = wx @@ -288,8 +290,9 @@ GENERATE_TREEVIEW = NO TREEVIEW_WIDTH = 250 #--------------------------------------------------------------------------- -# configuration options related to the LaTeX output +# LaTeX Output Options #--------------------------------------------------------------------------- + GENERATE_LATEX = NO # Only change in format output configs LATEX_OUTPUT = latex LATEX_CMD_NAME = latex @@ -304,8 +307,9 @@ LATEX_BATCHMODE = YES LATEX_HIDE_INDICES = NO #--------------------------------------------------------------------------- -# configuration options related to the RTF output +# RTF Output Options #--------------------------------------------------------------------------- + GENERATE_RTF = NO # Only change in format output configs RTF_OUTPUT = rtf COMPACT_RTF = NO @@ -314,16 +318,18 @@ RTF_STYLESHEET_FILE = RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- -# configuration options related to the man page output +# Man Page Output Options #--------------------------------------------------------------------------- + GENERATE_MAN = NO # Only change in format output configs MAN_OUTPUT = man MAN_EXTENSION = .3 MAN_LINKS = NO #--------------------------------------------------------------------------- -# configuration options related to the XML output +# XML Output Options #--------------------------------------------------------------------------- + GENERATE_XML = NO # Only change in format output configs XML_OUTPUT = xml XML_SCHEMA = @@ -331,21 +337,24 @@ XML_DTD = XML_PROGRAMLISTING = NO #--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output +# AutoGen Definitions Output Options #--------------------------------------------------------------------------- + GENERATE_AUTOGEN_DEF = NO # Only change in format output configs #--------------------------------------------------------------------------- -# configuration options related to the Perl module output +# Perl Module Output Options #--------------------------------------------------------------------------- + GENERATE_PERLMOD = NO # Only change in format output configs PERLMOD_LATEX = YES PERLMOD_PRETTY = YES PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- -# Configuration options related to the preprocessor +# Preprocessor Options #--------------------------------------------------------------------------- + ENABLE_PREPROCESSING = YES MACRO_EXPANSION = NO EXPAND_ONLY_PREDEF = NO @@ -357,8 +366,9 @@ EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# Additions Related to External References #--------------------------------------------------------------------------- + TAGFILES = GENERATE_TAGFILE = ALLEXTERNALS = NO @@ -366,8 +376,9 @@ EXTERNAL_GROUPS = YES PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# dot Tool Options #--------------------------------------------------------------------------- + CLASS_DIAGRAMS = YES MSCGEN_PATH = HIDE_UNDOC_RELATIONS = YES @@ -394,7 +405,8 @@ GENERATE_LEGEND = YES DOT_CLEANUP = YES #--------------------------------------------------------------------------- -# Configuration::additions related to the search engine +# Search Engine Options #--------------------------------------------------------------------------- + SEARCHENGINE = NO