Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Moved format selection logic into environment variables instead of conditional config file includes.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@72874 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2012-11-03 18:33:23 +00:00
parent c5a79f081d
commit b15e29d69c
11 changed files with 87 additions and 696 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/doxygen/Doxyfile
View File

@@ -331,14 +331,14 @@ IGNORE_PREFIX = wx
# HTML Output Options
#---------------------------------------------------------------------------
GENERATE_HTML = YES # Only re-enable in format-specific config files.
GENERATE_HTML = $(GENERATE_HTML)
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER = custom_header.html
HTML_FOOTER = custom_footer.html
HTML_STYLESHEET =
HTML_EXTRA_STYLESHEET = extra_stylesheet.css
HTML_EXTRA_FILES =
HTML_EXTRA_FILES = wxwidgets.js
HTML_COLORSTYLE_HUE = 220 # Default: 220
HTML_COLORSTYLE_SAT = 255 # Default: 100
HTML_COLORSTYLE_GAMMA = 100 # Default: 80
@@ -355,15 +355,15 @@ FORMULA_TRANSPARENT = YES
USE_MATHJAX = NO
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
MATHJAX_EXTENSIONS =
SEARCHENGINE = YES
SERVER_BASED_SEARCH = YES
SEARCHENGINE = $(SEARCHENGINE)
SERVER_BASED_SEARCH = $(SERVER_BASED_SEARCH)
#---------------------------------------------------------------------------
# Docset Output Options
#---------------------------------------------------------------------------
GENERATE_DOCSET = NO # Only re-enable in format-specific config files.
GENERATE_DOCSET = $(GENERATE_DOCSET)
DOCSET_FEEDNAME = "wxWidgets 2.9"
DOCSET_BUNDLE_ID = org.wxwidgets.doxygen.wx29
DOCSET_PUBLISHER_ID = org.wxwidgets.doxygen
@@ -374,7 +374,7 @@ DOCSET_PUBLISHER_NAME = wxWidgets Team
# CHM Output Options
#---------------------------------------------------------------------------
GENERATE_HTMLHELP = NO # Only re-enable in format-specific config files.
GENERATE_HTMLHELP = $(GENERATE_HTMLHELP)
CHM_FILE = ..\wx.chm # Windows style separator is required.
HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info
GENERATE_CHI = NO
@@ -387,7 +387,7 @@ TOC_EXPAND = NO
# QHP Output Options
#---------------------------------------------------------------------------
GENERATE_QHP = NO # Only re-enable in format-specific config files.
GENERATE_QHP = $(GENERATE_QHP)
QCH_FILE =
QHP_NAMESPACE = org.wxwidgets.doxygen
QHP_VIRTUAL_FOLDER = doc
@@ -401,7 +401,7 @@ QHG_LOCATION =
# Eclipse Output Options
#---------------------------------------------------------------------------
GENERATE_ECLIPSEHELP = NO # Only re-enable in format-specific config files.
GENERATE_ECLIPSEHELP = NO
ECLIPSE_DOC_ID = org.wxwidgets.doxygen
@@ -409,7 +409,7 @@ ECLIPSE_DOC_ID = org.wxwidgets.doxygen
# LaTeX Output Options
#---------------------------------------------------------------------------
GENERATE_LATEX = NO # Only re-enable in format-specific config files.
GENERATE_LATEX = $(GENERATE_LATEX)
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
@@ -430,7 +430,7 @@ LATEX_BIB_STYLE = plain
# RTF Output Options
#---------------------------------------------------------------------------
GENERATE_RTF = NO # Only re-enable in format-specific config files.
GENERATE_RTF = NO
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
@@ -442,7 +442,7 @@ RTF_EXTENSIONS_FILE =
# Man Page Output Options
#---------------------------------------------------------------------------
GENERATE_MAN = NO # Only re-enable in format-specific config files.
GENERATE_MAN = NO
MAN_OUTPUT = man
MAN_EXTENSION = .3
MAN_LINKS = NO
@@ -452,7 +452,7 @@ MAN_LINKS = NO
# XML Output Options
#---------------------------------------------------------------------------
GENERATE_XML = NO # Only re-enable in format-specific config files.
GENERATE_XML = $(GENERATE_XML)
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
@@ -463,14 +463,14 @@ XML_PROGRAMLISTING = NO # Default: YES
# AutoGen Definitions Output Options
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF = NO # Only re-enable in format-specific config files.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# Perl Module Output Options
#---------------------------------------------------------------------------
GENERATE_PERLMOD = NO # Only re-enable in format-specific config files.
GENERATE_PERLMOD = NO
PERLMOD_LATEX = YES # Default: NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =

26
docs/doxygen/Doxyfile_all
View File

@@ -1,26 +0,0 @@
#############################################################################
## Name: Doxyfile.all
## Purpose: Doxygen configuration file for generating all main formats
## Author: Francesco Montorsi
## RCS-ID: $Id$
## Licence: wxWindows licence
#############################################################################
@INCLUDE = Doxyfile_inc
#---------------------------------------------------------------------------
# Generation switches
#---------------------------------------------------------------------------
# This file generates all the official formats we distribute.
GENERATE_HTML = YES
GENERATE_HTMLHELP = YES
GENERATE_LATEX = NO
GENERATE_RTF = NO
GENERATE_MAN = NO
GENERATE_XML = YES
GENERATE_AUTOGEN_DEF = NO
GENERATE_PERLMOD = YES
GENERATE_TAGFILE =

38
docs/doxygen/Doxyfile_chm
View File

@@ -1,38 +0,0 @@
#############################################################################
## Name: Doxyfile.chm
## Purpose: Doxygen configuration file for generating CHM only
## Author: Francesco Montorsi
## RCS-ID: $Id$
## Licence: wxWindows licence
#############################################################################
@INCLUDE = Doxyfile_inc
# HTML Help Compiler (hhc.exe) is the compiler used to produce CHM files from
# the HTML sources. You are required to install HHC to generate this format.
#
# Windows:
# You can download it for free from MS website:
# <http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en>
# Then set the HHC_PATH environment variable to the folder where you
# installed HHC. See <http://www.computerhope.com/issues/ch000549.htm>
# for more info about how to set env variables in WinXP or newer.
#
# Unix:
# You can install the Windows version of the compiler under WINE
# <http://www.winehq.org/> following the instructions placed here:
# <http://appdb.winehq.org/objectManager.php?sClass=application&iId=2140>
# Then place the hhc.exe executable in your PATH. You can add to your
# ~/.bashrc (if you use bash):
# PATH=$PATH:~/.wine/drive_c/Program Files/HTML Help Workshop
# export PATH
#---------------------------------------------------------------------------
# Generation switches
#---------------------------------------------------------------------------
# NOTE: GENERATE_HTML must be set to YES otherwise doxygen won't generate the
# index.hhp file and the CHM compilation will fail!
GENERATE_HTML = YES
GENERATE_HTMLHELP = YES

16
docs/doxygen/Doxyfile_docset
View File

@@ -1,16 +0,0 @@
#############################################################################
## Name: Doxyfile_docset
## Purpose: Doxygen configuration file for generating Apple DocSet
## Author: Bryan Petty
## RCS-ID: $Id$
## Licence: wxWindows licence
#############################################################################
@INCLUDE = Doxyfile_inc
#---------------------------------------------------------------------------
# Generation switches
#---------------------------------------------------------------------------
GENERATE_DOCSET = YES
GENERATE_HTML = YES

18
docs/doxygen/Doxyfile_html
View File

@@ -1,18 +0,0 @@
#############################################################################
## Name: Doxyfile.html
## Purpose: Doxygen configuration file for generating HTML only
## Author: Francesco Montorsi
## RCS-ID: $Id$
## Licence: wxWindows licence
#############################################################################
@INCLUDE = Doxyfile_inc
#---------------------------------------------------------------------------
# Generation switches
#---------------------------------------------------------------------------
GENERATE_HTML = YES
SEARCHENGINE = YES
SERVER_BASED_SEARCH = NO

502
docs/doxygen/Doxyfile_inc
View File

@@ -1,502 +0,0 @@
#############################################################################
## Name: Doxyfile_inc
## Purpose: Main configuration file for the wxWidgets manual
## Author: Francesco Montorsi
## RCS-ID: $Id$
## Licence: wxWindows licence
#############################################################################
#---------------------------------------------------------------------------
# Project Options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = wxWidgets
PROJECT_NUMBER = 2.9.5
PROJECT_BRIEF =
PROJECT_LOGO = logo.png
OUTPUT_DIRECTORY = out
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF =
ALWAYS_DETAILED_SEC = YES
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES
STRIP_FROM_PATH = "$(WXWIDGETS)/"
STRIP_FROM_INC_PATH = "$(WXWIDGETS)/include/" \
"$(WXWIDGETS)/interface/"
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES
QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 4
OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
OPTIMIZE_FOR_FORTRAN = NO
OPTIMIZE_OUTPUT_VHDL = NO
BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = NO
SIP_SUPPORT = NO
IDL_PROPERTY_SUPPORT = NO
DISTRIBUTE_GROUP_DOC = YES
SUBGROUPING = YES
TYPEDEF_HIDES_STRUCT = NO
SYMBOL_CACHE_SIZE = 0
# This is the most important part of the wxWidgets Doxyfile; aliases allow
# us to keep the headers readable and "implement" wxWidgets-specific commands:
#---------------------------------------------------------------------------
# Aliases - for use when documenting C++ classes
#---------------------------------------------------------------------------
# aliases to be used by classes which emit wxEvents (e.g. wxWindow, wxTextCtrl, etc):
ALIASES = beginEventEmissionTable="\n<h2>Events emitted by this class</h2><p>Event macros for events emitted by this class:</p><div>"
ALIASES += beginEventEmissionTable{1}="\n<h2>Events emitted by this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p>Event macros for events emitted by this class:<div>"
ALIASES += beginEventEmissionTable{2}="\n<h2>Events emitted by this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span> or <span>void&nbsp;handlerFuncName(\2&&nbsp;event)</span></div></p>Event macros for events emitted by this class:<div>"
# aliases to be used in wxEvent-derived classes:
ALIASES += beginEventTable{1}="\n<h2>Events using this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p>Event macros:<div>"
ALIASES += beginEventTable{2}="\n<h2>Events using this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span> or <span>void&nbsp;handlerFuncName(\2&&nbsp;event)</span></div></p>Event macros:<div>"
# common event aliases:
ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
ALIASES += event{4}="</div>\li <span class='event'>\1, \2, \3, \4</span>:<div class='eventDesc'>"
ALIASES += endEventTable="</div>\n"
# style aliases
ALIASES += beginStyleTable="\n<h2>Styles</h2><p>This class supports the following styles:</p><div>"
ALIASES += style{1}="</div>\li <span class='style'>\1</span>:<div class='styleDesc'>"
ALIASES += endStyleTable="</div>\n"
# extra style aliases
ALIASES += beginExtraStyleTable="\n<hr><h2>Extra styles</h2><p>This class supports the following extra styles:</p><div>"
ALIASES += endExtraStyleTable="</div>\n"
# flag aliases
ALIASES += beginFlagTable="<div>"
ALIASES += flag{1}="</div>\li <span class='flag'>\1</span>:<div class='flagDesc'>"
ALIASES += endFlagTable="</div>\n"
# creates appearance section: this should be used for all main GUI controls
# that look different in different ports. genericAppearance can be used for the
# controls that always look the same.
ALIASES += appearance{1}="\htmlonly <br><div><span class='appearance'>Appearance:</span><br><table class='appearance'><tr><td><img src='wxmsw/\1' alt='wxMSW appearance' class='appearance'/></td><td><img src='wxgtk/\1' alt='wxGTK appearance' class='appearance'/></td><td><img src='wxmac/\1' alt='wxMac appearance' class='appearance'/></td></tr><tr><td>wxMSW appearance</td><td>wxGTK appearance</td><td>wxMac appearance</td></tr></table></div> \endhtmlonly"
ALIASES += genericAppearance{1}="\htmlonly <br><div><span class='appearance'>Appearance:</span><br><table class='appearance'><tr><td><img src='generic/\1' alt='Generic appearance' class='appearance'/></td></tr></table></div> \endhtmlonly"
# aliases for the creation of "named member groups"
# USAGE: the first argument must not contain spaces and be a unique identifier
# of the member group for the class being documented;
# the second argument is the member group name and can contain spaces
# See wxString as an usage example.
# NOTE: no warnings are given for wrong member group names so be careful and check
# the doxygen output to verify that there are no typos
ALIASES += member_group_name{2}="<a name='\1'></a> \name \2"
ALIASES += ref_member_group{2}="<a href='#\1' class='el'>\2</a>"
#---------------------------------------------------------------------------
# Aliases - for use when documenting any C++ entity
#---------------------------------------------------------------------------
# aliases for additional wx-specific infos
ALIASES += category{1}="\ingroup group_class_\1 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1</span></div>"
ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1, \ref group_class_\2</span></div>"
ALIASES += category{3}="\ingroup group_class_\1 group_class_\2 group_class_\3 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1, \ref group_class_\2, \ref group_class_\3</span></div>"
ALIASES += library{1}="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
ALIASES += nolibrary="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
# native implementation infos:
ALIASES += nativeimpl{1}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1 port; a generic implementation is used elsewhere.</div>"
ALIASES += nativeimpl{2}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1, \ref page_port_\2 ports; a generic implementation is used elsewhere.</div>"
ALIASES += nativeimpl{3}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports; a generic implementation is used elsewhere.</div>"
ALIASES += nativeimpl{4}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports; a generic implementation is used elsewhere.</div>"
# onlyfor infos:
# NOTE: we need to be able to retrieve these infos also from the XML output, thus
# we use the \xmlonly and \endxmlonly commands to include custom XML tags
ALIASES += onlyfor{1}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1 port.</div> \xmlonly <onlyfor>\1</onlyfor> \endxmlonly"
ALIASES += onlyfor{2}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2 ports.</div> \xmlonly <onlyfor>\1,\2</onlyfor> \endxmlonly"
ALIASES += onlyfor{3}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports.</div> \xmlonly <onlyfor>\1,\2,\3</onlyfor> \endxmlonly"
ALIASES += onlyfor{4}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports.</div> \xmlonly <onlyfor>\1,\2,\3,\4</onlyfor> \endxmlonly"
# 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"
# some formatting aliases
ALIASES += true="<span class='literal'>true</span>"
ALIASES += false="<span class='literal'>false</span>"
ALIASES += NULL="<span class='literal'>NULL</span>"
ALIASES += NUL="<span class='literal'>NUL</span>"
# NOTE: these are important as you can't write in the docs
# just #ifdef since the # character is used by Doxygen
# for explicit linking; use the following aliases instead!
# However to avoid overwriting e.g. \if Doxygen command the _
# character is postfixed
ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
ALIASES += if_="<span class='literal'>\#if</span>"
ALIASES += endif_="<span class='literal'>\#endif</span>"
# table aliases for 2 and 3 column tables
ALIASES += beginTable="<table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
ALIASES += beginInvisibleTable="<table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>"
ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>"
ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>"
ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>"
ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>"
ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>"
ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
ALIASES += hdr3col{3}="<tr><th>\1</th> <th>\2</th> <th>\3</th></tr>"
ALIASES += endTable="</table>"
# definition list aliases
# a definition list currently is rendered as 2-column table but it may use as
# well the <dl>, <dt> and <dd> HTML tags in future.
# In any case a definition list differs from a table because of its semantic
# nature and because it is always the association of a "title" with a "description"
# (in contrast a table may have more than 2 columns of data)...
ALIASES += beginDefList="<table class='doclist' border='1' cellspacing='0'>"
ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
ALIASES += endDefList="</table>"
ALIASES += stock{3}="<tr><td><span class='itemdef'>\1</span></td> <td> @image html gtk-\2.png\n</td><td>\3</td></tr>"
#---------------------------------------------------------------------------
# Aliases - for use when documenting wxPerl/wxPython-specific parts
#---------------------------------------------------------------------------
# See ENABLED_SECTIONS configuration key for more info about these:
ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
ALIASES += endWxPerlOnly="\endif"
# This is to get around a bug in Doxygen that prevents use of '{' or '}'
# inside of any aliased command in parameters.
ALIASES += leftCurly="{"
ALIASES += rightCurly="}"
#---------------------------------------------------------------------------
# Aliases - for use when documenting samples
#---------------------------------------------------------------------------
# For indicating a sample location
ALIASES += sampledir{1}="@e Location: @c samples/\1 subdirectory of your wxWidgets installation or http://svn.wxwidgets.org/viewvc/wx/wxWidgets/trunk/samples/\1"
# 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}="<b>Build Note:</b> You may need to build the wxWidgets library with <tt>\1</tt> being set to 1 to be able to make it work, please read comments in @c <wx/setup_inc.h> for more info."
ALIASES += buildwith{2}="<b>Build Note:</b> You may need to build the wxWidgets library with <tt>\1</tt> and <tt>\2</tt> being set to 1 to be able to make it work, please read comments in @c <wx/setup_inc.h> for more info."
#---------------------------------------------------------------------------
# Build Options
#---------------------------------------------------------------------------
EXTRACT_ALL = YES
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = YES
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = NO
HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO # Don't set to YES, it renders our named groups out of order.
SORT_GROUP_NAMES = YES
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
# can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = NO
SHOW_DIRECTORIES = YES
SHOW_FILES = YES
SHOW_NAMESPACES = NO
FILE_VERSION_FILTER =
LAYOUT_FILE = DoxygenLayout.xml
#---------------------------------------------------------------------------
# Warning and Progress Message Options
#---------------------------------------------------------------------------
QUIET = YES
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = YES
WARN_FORMAT = "$file:$line: $text "
WARN_LOGFILE = doxygen.log
#---------------------------------------------------------------------------
# Input File Options
#---------------------------------------------------------------------------
INPUT = ./mainpages ./groups ./overviews ../../interface
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.h *.txt
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
EXAMPLE_PATH = ../
EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = NO
IMAGE_PATH = images
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# Source Browsing Options
#---------------------------------------------------------------------------
SOURCE_BROWSER = NO
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = NO
REFERENCES_RELATION = NO
REFERENCES_LINK_SOURCE = YES
USE_HTAGS = NO
VERBATIM_HEADERS = NO
#---------------------------------------------------------------------------
# Alphabetical Class Index Options
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX = wx
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = NO # Only change in format output configs
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER = custom_header.html
HTML_FOOTER = custom_footer.html
HTML_STYLESHEET = custom_stylesheet.css
HTML_EXTRA_FILES = jquery-1.3.2.min.js
HTML_COLORSTYLE_HUE =
HTML_COLORSTYLE_SAT = 255
HTML_COLORSTYLE_GAMMA = 100
HTML_TIMESTAMP = YES
HTML_ALIGN_MEMBERS = YES
HTML_DYNAMIC_SECTIONS = YES
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 1
GENERATE_TREEVIEW = NO
USE_INLINE_TREES = NO
TREEVIEW_WIDTH = 250
EXT_LINKS_IN_WINDOW = YES
FORMULA_FONTSIZE = 10
FORMULA_TRANSPARENT = YES
#---------------------------------------------------------------------------
# configuration options related to the CHM output
#---------------------------------------------------------------------------
GENERATE_HTMLHELP = NO # Only change in format output configs
CHM_FILE = ..\wx.chm # NOTE: Windows style separator needed
HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
#---------------------------------------------------------------------------
# configuration options related to the Qt Help Project output
#---------------------------------------------------------------------------
GENERATE_QHP = NO # Only change in format output configs
QCH_FILE =
QHP_NAMESPACE = org.wxwidgets.doxygen
QHP_VIRTUAL_FOLDER = doc
QHG_LOCATION =
#---------------------------------------------------------------------------
# configuration options related to the Docset output
#---------------------------------------------------------------------------
GENERATE_DOCSET = NO # Only change in format output configs
DOCSET_FEEDNAME = "wxWidgets 2.9"
DOCSET_BUNDLE_ID = org.wxwidgets.doxygen.wx29
DOCSET_PUBLISHER_ID = org.wxwidgets.doxygen
DOCSET_PUBLISHER_NAME = wxWidgets Team
#---------------------------------------------------------------------------
# LaTeX Output Options
#---------------------------------------------------------------------------
GENERATE_LATEX = NO # Only change in format output configs
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
LATEX_HEADER = latexdocstart.inc
PDF_HYPERLINKS = YES
USE_PDFLATEX = YES
LATEX_BATCHMODE = YES
LATEX_HIDE_INDICES = NO
#---------------------------------------------------------------------------
# RTF Output Options
#---------------------------------------------------------------------------
GENERATE_RTF = NO # Only change in format output configs
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# Man Page Output Options
#---------------------------------------------------------------------------
GENERATE_MAN = NO # Only change in format output configs
MAN_OUTPUT = man
MAN_EXTENSION = .3
MAN_LINKS = NO
#---------------------------------------------------------------------------
# XML Output Options
#---------------------------------------------------------------------------
GENERATE_XML = NO # Only change in format output configs
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
XML_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
# AutoGen Definitions Output Options
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF = NO # Only change in format output configs
#---------------------------------------------------------------------------
# Perl Module Output Options
#---------------------------------------------------------------------------
GENERATE_PERLMOD = NO # Only change in format output configs
PERLMOD_LATEX = YES
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Preprocessor Options
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED =
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Additions Related to External References
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# dot Tool Options
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = YES
MSCGEN_PATH =
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = YES
DOT_FONTNAME = FreeSans
DOT_FONTSIZE = 10
DOT_FONTPATH =
CLASS_GRAPH = YES
COLLABORATION_GRAPH = NO
GROUP_GRAPHS = NO
UML_LOOK = NO
TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = NO
INCLUDED_BY_GRAPH = NO
CALL_GRAPH = NO
CALLER_GRAPH = NO
GRAPHICAL_HIERARCHY = NO
DIRECTORY_GRAPH = NO
DOT_IMAGE_FORMAT = png
DOTFILE_DIRS =
DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 1000
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
# instead of setting a value for DOT_PATH it's easier and more portable to
# put your dot utility in the PATH; if you are on a Unix system this is usually
# done automatically; if you're on Windows you'll need to install GraphViz tools
# and then manually add it to the PATH environment variable
DOT_PATH =
#---------------------------------------------------------------------------
# Search Engine Options
#---------------------------------------------------------------------------
SEARCHENGINE = NO

16
docs/doxygen/Doxyfile_latex
View File

@@ -1,16 +0,0 @@
#############################################################################
## Name: Doxyfile.latex
## Purpose: Doxygen configuration file for generating Latex only
## Author: Stefan Csomor
## RCS-ID: $Id$
## Licence: wxWindows licence
#############################################################################
@INCLUDE = Doxyfile_inc
#---------------------------------------------------------------------------
# Generation switches
#---------------------------------------------------------------------------
GENERATE_LATEX = YES

24
docs/doxygen/Doxyfile_qch
View File

@@ -1,24 +0,0 @@
#############################################################################
## Name: Doxyfile.qch
## Purpose: Doxygen configuration file for generating QCH only
## Author: Francesco Montorsi
## RCS-ID: $Id$
## Licence: wxWindows licence
#############################################################################
@INCLUDE = Doxyfile_inc
#---------------------------------------------------------------------------
# Generation switches
#---------------------------------------------------------------------------
GENERATE_HTML = YES
GENERATE_QHP = YES
# the qhelpgenerator utility is typically part of a package named like
# "qt4-dev-tools" in linux distributions:
##QHG_LOCATION = /usr/bin/qhelpgenerator
# see http://doc.trolltech.com/4.4/qthelpproject.html for more info
QHP_NAMESPACE = wx
QHP_VIRTUAL_FOLDER = wxdoc

16
docs/doxygen/Doxyfile_xml
View File

@@ -1,16 +0,0 @@
#############################################################################
## Name: Doxyfile.xml
## Purpose: Doxygen configuration file for generating XML only
## Author: Francesco Montorsi
## RCS-ID: $Id$
## Licence: wxWindows licence
#############################################################################
@INCLUDE = Doxyfile_inc
#---------------------------------------------------------------------------
# Generation switches
#---------------------------------------------------------------------------
GENERATE_XML = YES

45
docs/doxygen/mainpages/platdetails.h
View File

@@ -382,19 +382,19 @@ essentially the usual wxWidgets API; wxWidgets will combine the menubar and
toolbar. However, there are some restrictions:
@li You must create the frame's primary toolbar with wxFrame::CreateToolBar(),
because this uses the special wxToolMenuBar class (derived from wxToolBar) to
implement the combined toolbar and menubar. Otherwise, you can create and
manage toolbars using the wxToolBar class as usual, for example to implement an
optional formatting toolbar above the menubar as Pocket Word does. But don't
assign a wxToolBar to a frame using SetToolBar - you should always use
CreateToolBar for the main frame toolbar.
because this uses the special wxToolMenuBar class (derived from wxToolBar)
to implement the combined toolbar and menubar. Otherwise, you can create
and manage toolbars using the wxToolBar class as usual, for example to
implement an optional formatting toolbar above the menubar as Pocket Word
does. But don't assign a wxToolBar to a frame using SetToolBar - you should
always use CreateToolBar for the main frame toolbar.
@li Deleting and adding tools to wxToolMenuBar after Realize is called is not
@supported.
supported.
@li For speed, colours are not remapped to the system colours as they are in
wxMSW. Provide the tool bitmaps either with the correct system button
background, or with transparency (for example, using XPMs).
wxMSW. Provide the tool bitmaps either with the correct system button
background, or with transparency (for example, using XPMs).
@li Adding controls to wxToolMenuBar is not supported. However, wxToolBar
supports controls.
supports controls.
Unlike in all other ports, a wxDialog has a wxToolBar automatically created for
you. You may either leave it blank, or access it with wxDialog::GetToolBar()
@@ -529,17 +529,26 @@ eVC++ format.
When you have converted the wxWidgets workspace, edit the configuration
properties for each configuration and in the Librarian, add a relative path
..\\..\\lib to each library path. For example:
<tt>..\\$(PlatformName)\\$(ConfigurationName)\\wx_mono.lib</tt>.
@verbatim ..\..\lib @endverbatim
to each library path. For example:
@verbatim ..\$(PlatformName)\$(ConfigurationName)\wx_mono.lib @endverbatim
Then, for a sample you want to compile, edit the configuration properties
and make sure
<tt>..\\..\\lib\\$(PlatformName)\\$(ConfigurationName)</tt>
is in the Linker/General/Additional Library Directories property.
Also change the Linker/Input/Additional Dependencies property to something like
<tt>coredll.lib wx_mono.lib wx_wxjpeg.lib wx_wxpng.lib wx_wxzlib.lib wx_wxexpat.lib
commctrl.lib winsock.lib wininet.lib</tt>
(since the library names in the wxWidgets workspace were changed by VS 2005).
@verbatim ..\..\lib\$(PlatformName)\$(ConfigurationName) @endverbatim
is in the Linker/General/Additional Library Directories property. Also change
the Linker/Input/Additional Dependencies property to something like
@verbatim
coredll.lib wx_mono.lib wx_wxjpeg.lib wx_wxpng.lib wx_wxzlib.lib wx_wxexpat.lib commctrl.lib winsock.lib wininet.lib
@endverbatim
since the library names in the wxWidgets workspace were changed by VS 2005.
Alternately, you could edit all the names to be identical to the original eVC++
names, but this will probably be more fiddly.

54
docs/doxygen/regen.sh
View File

@@ -47,14 +47,52 @@ mkdir -p out/html/generic
# used in doxygen documentation, only in our html footer and by our
# custom aliases
cp images/generic/*png out/html/generic
cp wxwidgets.js out/html
# which configuration should we use?
if [[ -z "$1" ]]; then
cfgfile="Doxyfile_all"
else
cfgfile="Doxyfile_$1"
fi
# Defaults for settings controlled by this script
export GENERATE_DOCSET="NO";
export GENERATE_HTML="NO";
export GENERATE_HTMLHELP="NO";
export GENERATE_LATEX="NO";
export GENERATE_QHP="NO";
export GENERATE_XML="NO";
export SEARCHENGINE="NO";
export SERVER_BASED_SEARCH="NO";
# Which format should we generate during this run?
case "$1" in
all) # All *main* formats, not all formats, here for backwards compat.
export GENERATE_HTML="YES";
export GENERATE_HTMLHELP="YES";
export GENERATE_XML="YES";
;;
chm)
export GENERATE_HTML="YES";
export GENERATE_HTMLHELP="YES";
;;
docset)
export GENERATE_DOCSET="YES";
export GENERATE_HTML="YES";
;;
latex)
export GENERATE_LATEX="YES";
;;
php) # HTML, but with PHP Search Engine
export GENERATE_HTML="YES";
export SEARCHENGINE="YES";
export SERVER_BASED_SEARCH="YES";
;;
qch)
export GENERATE_HTML="YES";
export GENERATE_QHP="YES";
;;
xml)
export GENERATE_XML="YES";
;;
*) # Default to HTML only
export GENERATE_HTML="YES";
export SEARCHENGINE="YES";
;;
esac
#
# NOW RUN DOXYGEN
@@ -63,7 +101,7 @@ fi
# otherwise when generating the CHM file with Doxygen, those files are
# not included!
#
$DOXYGEN $cfgfile
$DOXYGEN Doxyfile
if [[ "$1" = "qch" ]]; then
# we need to add missing files to the .qhp