git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2839 35acf78f-673a-0410-8e92-d51de3d6d3f4
parent
9d812b5db3
commit
506212845d
328
docs/Doxyfile
328
docs/Doxyfile
|
@ -1,14 +1,14 @@
|
||||||
# Doxyfile 1.6.3
|
# Doxyfile 1.7.3
|
||||||
|
|
||||||
# This file describes the settings to be used by the documentation system
|
# This file describes the settings to be used by the documentation system
|
||||||
# doxygen (www.doxygen.org) for a project
|
# doxygen (www.doxygen.org) for a project.
|
||||||
#
|
#
|
||||||
# All text after a hash (#) is considered a comment and will be ignored
|
# All text after a hash (#) is considered a comment and will be ignored.
|
||||||
# The format is:
|
# The format is:
|
||||||
# TAG = value [value, ...]
|
# TAG = value [value, ...]
|
||||||
# For lists items can also be appended using:
|
# For lists items can also be appended using:
|
||||||
# TAG += value [value, ...]
|
# TAG += value [value, ...]
|
||||||
# Values that contain spaces should be placed between quotes (" ")
|
# Values that contain spaces should be placed between quotes (" ").
|
||||||
|
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
# Project related configuration options
|
# Project related configuration options
|
||||||
|
@ -33,6 +33,17 @@ PROJECT_NAME = ChibiOS/RT
|
||||||
|
|
||||||
PROJECT_NUMBER = 2.3.1
|
PROJECT_NUMBER = 2.3.1
|
||||||
|
|
||||||
|
# Using the PROJECT_BRIEF tag one can provide an optional one line description for a project that appears at the top of each page and should give viewer a quick idea about the purpose of the project. Keep the description short.
|
||||||
|
|
||||||
|
PROJECT_BRIEF =
|
||||||
|
|
||||||
|
# With the PROJECT_LOGO tag one can specify an logo or icon that is
|
||||||
|
# included in the documentation. The maximum height of the logo should not
|
||||||
|
# exceed 55 pixels and the maximum width should not exceed 200 pixels.
|
||||||
|
# Doxygen will copy the logo to the output directory.
|
||||||
|
|
||||||
|
PROJECT_LOGO =
|
||||||
|
|
||||||
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
||||||
# base path where the generated documentation will be put.
|
# base path where the generated documentation will be put.
|
||||||
# If a relative path is entered, it will be relative to the location
|
# If a relative path is entered, it will be relative to the location
|
||||||
|
@ -57,7 +68,7 @@ CREATE_SUBDIRS = NO
|
||||||
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
|
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
|
||||||
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
|
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
|
||||||
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
|
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
|
||||||
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
|
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
|
||||||
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
|
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
|
||||||
|
|
||||||
OUTPUT_LANGUAGE = English
|
OUTPUT_LANGUAGE = English
|
||||||
|
@ -136,7 +147,7 @@ STRIP_FROM_PATH = "C:/Documents and Settings/Administrator/"
|
||||||
STRIP_FROM_INC_PATH =
|
STRIP_FROM_INC_PATH =
|
||||||
|
|
||||||
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
|
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
|
||||||
# (but less readable) file names. This can be useful is your file systems
|
# (but less readable) file names. This can be useful if your file system
|
||||||
# doesn't support long names like on DOS, Mac, or CD-ROM.
|
# doesn't support long names like on DOS, Mac, or CD-ROM.
|
||||||
|
|
||||||
SHORT_NAMES = NO
|
SHORT_NAMES = NO
|
||||||
|
@ -189,26 +200,26 @@ TAB_SIZE = 2
|
||||||
# will result in a user-defined paragraph with heading "Side Effects:".
|
# will result in a user-defined paragraph with heading "Side Effects:".
|
||||||
# You can put \n's in the value part of an alias to insert newlines.
|
# You can put \n's in the value part of an alias to insert newlines.
|
||||||
|
|
||||||
ALIASES = "iclass=@par Function Class:\n This is an \
|
ALIASES = "iclass=@par Function Class:\n This is an \
|
||||||
<b>I-Class</b> API, this function can be \
|
<b>I-Class</b> API, this function can be \
|
||||||
invoked from within a system lock zone by both \
|
invoked from within a system lock zone by both \
|
||||||
threads and interrupt handlers." \
|
threads and interrupt handlers." \
|
||||||
"sclass=@par Function Class:\n This is an \
|
"sclass=@par Function Class:\n This is an \
|
||||||
<b>S-Class</b> API, this function can be \
|
<b>S-Class</b> API, this function can be \
|
||||||
invoked from within a system lock zone by threads \
|
invoked from within a system lock zone by threads \
|
||||||
only." \
|
only." \
|
||||||
"api=@par Function Class:\n Normal API, this \
|
"api=@par Function Class:\n Normal API, this \
|
||||||
function can be invoked by regular system threads \
|
function can be invoked by regular system threads \
|
||||||
but not from within a lock zone." \
|
but not from within a lock zone." \
|
||||||
"notapi=@par Function Class:\n Not an API, this \
|
"notapi=@par Function Class:\n Not an API, this \
|
||||||
function is for internal use only." \
|
function is for internal use only." \
|
||||||
"isr=@par Function Class:\n Interrupt handler, \
|
"isr=@par Function Class:\n Interrupt handler, \
|
||||||
this function should not be directly invoked." \
|
this function should not be directly invoked." \
|
||||||
"init=@par Function Class:\n Initializer, this \
|
"init=@par Function Class:\n Initializer, this \
|
||||||
function just initializes an object and can be \
|
function just initializes an object and can be \
|
||||||
invoked before the kernel is initialized." \
|
invoked before the kernel is initialized." \
|
||||||
"special=@par Function Class:\n Special function, \
|
"special=@par Function Class:\n Special function, \
|
||||||
this function has special requirements see the \
|
this function has special requirements see the \
|
||||||
notes."
|
notes."
|
||||||
|
|
||||||
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
|
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
|
||||||
|
@ -237,15 +248,15 @@ OPTIMIZE_FOR_FORTRAN = NO
|
||||||
|
|
||||||
OPTIMIZE_OUTPUT_VHDL = NO
|
OPTIMIZE_OUTPUT_VHDL = NO
|
||||||
|
|
||||||
# Doxygen selects the parser to use depending on the extension of the files it parses.
|
# Doxygen selects the parser to use depending on the extension of the files it
|
||||||
# With this tag you can assign which parser to use for a given extension.
|
# parses. With this tag you can assign which parser to use for a given extension.
|
||||||
# Doxygen has a built-in mapping, but you can override or extend it using this tag.
|
# Doxygen has a built-in mapping, but you can override or extend it using this
|
||||||
# The format is ext=language, where ext is a file extension, and language is one of
|
# tag. The format is ext=language, where ext is a file extension, and language
|
||||||
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
|
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
|
||||||
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
|
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
|
||||||
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
|
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
|
||||||
# use: inc=Fortran f=C. Note that for custom extensions you also need to set
|
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
|
||||||
# FILE_PATTERNS otherwise the files are not read by doxygen.
|
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
|
||||||
|
|
||||||
EXTENSION_MAPPING =
|
EXTENSION_MAPPING =
|
||||||
|
|
||||||
|
@ -253,7 +264,7 @@ EXTENSION_MAPPING =
|
||||||
# to include (a tag file for) the STL sources as input, then you should
|
# to include (a tag file for) the STL sources as input, then you should
|
||||||
# set this tag to YES in order to let doxygen match functions declarations and
|
# set this tag to YES in order to let doxygen match functions declarations and
|
||||||
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
|
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
|
||||||
# func(std::string) {}). This also make the inheritance and collaboration
|
# func(std::string) {}). This also makes the inheritance and collaboration
|
||||||
# diagrams that involve STL classes more complete and accurate.
|
# diagrams that involve STL classes more complete and accurate.
|
||||||
|
|
||||||
BUILTIN_STL_SUPPORT = NO
|
BUILTIN_STL_SUPPORT = NO
|
||||||
|
@ -271,7 +282,7 @@ SIP_SUPPORT = NO
|
||||||
|
|
||||||
# For Microsoft's IDL there are propget and propput attributes to indicate getter
|
# For Microsoft's IDL there are propget and propput attributes to indicate getter
|
||||||
# and setter methods for a property. Setting this option to YES (the default)
|
# and setter methods for a property. Setting this option to YES (the default)
|
||||||
# will make doxygen to replace the get and set methods by a property in the
|
# will make doxygen replace the get and set methods by a property in the
|
||||||
# documentation. This will only work if the methods are indeed getting or
|
# documentation. This will only work if the methods are indeed getting or
|
||||||
# setting a simple type. If this is not the case, or you want to show the
|
# setting a simple type. If this is not the case, or you want to show the
|
||||||
# methods anyway, you should set this option to NO.
|
# methods anyway, you should set this option to NO.
|
||||||
|
@ -309,10 +320,10 @@ TYPEDEF_HIDES_STRUCT = NO
|
||||||
# For small to medium size projects (<1000 input files) the default value is
|
# For small to medium size projects (<1000 input files) the default value is
|
||||||
# probably good enough. For larger projects a too small cache size can cause
|
# probably good enough. For larger projects a too small cache size can cause
|
||||||
# doxygen to be busy swapping symbols to and from disk most of the time
|
# doxygen to be busy swapping symbols to and from disk most of the time
|
||||||
# causing a significant performance penality.
|
# causing a significant performance penalty.
|
||||||
# If the system has enough physical memory increasing the cache will improve the
|
# If the system has enough physical memory increasing the cache will improve the
|
||||||
# performance by keeping more symbols in memory. Note that the value works on
|
# performance by keeping more symbols in memory. Note that the value works on
|
||||||
# a logarithmic scale so increasing the size by one will rougly double the
|
# a logarithmic scale so increasing the size by one will roughly double the
|
||||||
# memory usage. The cache size is given by this formula:
|
# memory usage. The cache size is given by this formula:
|
||||||
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
|
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
|
||||||
# corresponding to a cache size of 2^16 = 65536 symbols
|
# corresponding to a cache size of 2^16 = 65536 symbols
|
||||||
|
@ -357,7 +368,7 @@ EXTRACT_LOCAL_METHODS = NO
|
||||||
# extracted and appear in the documentation as a namespace called
|
# extracted and appear in the documentation as a namespace called
|
||||||
# 'anonymous_namespace{file}', where file will be replaced with the base
|
# 'anonymous_namespace{file}', where file will be replaced with the base
|
||||||
# name of the file that contains the anonymous namespace. By default
|
# name of the file that contains the anonymous namespace. By default
|
||||||
# anonymous namespace are hidden.
|
# anonymous namespaces are hidden.
|
||||||
|
|
||||||
EXTRACT_ANON_NSPACES = NO
|
EXTRACT_ANON_NSPACES = NO
|
||||||
|
|
||||||
|
@ -468,6 +479,12 @@ SORT_GROUP_NAMES = NO
|
||||||
|
|
||||||
SORT_BY_SCOPE_NAME = NO
|
SORT_BY_SCOPE_NAME = NO
|
||||||
|
|
||||||
|
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper type resolution of all parameters of a function it will reject a
|
||||||
|
# match between the prototype and the implementation of a member function even if there is only one candidate or it is obvious which candidate to choose by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
|
||||||
|
# will still accept a match between prototype and implementation in such cases.
|
||||||
|
|
||||||
|
STRICT_PROTO_MATCHING = NO
|
||||||
|
|
||||||
# The GENERATE_TODOLIST tag can be used to enable (YES) or
|
# The GENERATE_TODOLIST tag can be used to enable (YES) or
|
||||||
# disable (NO) the todo list. This list is created by putting \todo
|
# disable (NO) the todo list. This list is created by putting \todo
|
||||||
# commands in the documentation.
|
# commands in the documentation.
|
||||||
|
@ -498,10 +515,10 @@ GENERATE_DEPRECATEDLIST= YES
|
||||||
ENABLED_SECTIONS =
|
ENABLED_SECTIONS =
|
||||||
|
|
||||||
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
|
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
|
||||||
# the initial value of a variable or define consists of for it to appear in
|
# the initial value of a variable or macro consists of for it to appear in
|
||||||
# the documentation. If the initializer consists of more lines than specified
|
# the documentation. If the initializer consists of more lines than specified
|
||||||
# here it will be hidden. Use a value of 0 to hide initializers completely.
|
# here it will be hidden. Use a value of 0 to hide initializers completely.
|
||||||
# The appearance of the initializer of individual variables and defines in the
|
# The appearance of the initializer of individual variables and macros in the
|
||||||
# documentation can be controlled using \showinitializer or \hideinitializer
|
# documentation can be controlled using \showinitializer or \hideinitializer
|
||||||
# command in the documentation regardless of this setting.
|
# command in the documentation regardless of this setting.
|
||||||
|
|
||||||
|
@ -526,7 +543,8 @@ SHOW_DIRECTORIES = NO
|
||||||
SHOW_FILES = YES
|
SHOW_FILES = YES
|
||||||
|
|
||||||
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
|
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
|
||||||
# Namespaces page. This will remove the Namespaces entry from the Quick Index
|
# Namespaces page.
|
||||||
|
# This will remove the Namespaces entry from the Quick Index
|
||||||
# and from the Folder Tree View (if specified). The default is YES.
|
# and from the Folder Tree View (if specified). The default is YES.
|
||||||
|
|
||||||
SHOW_NAMESPACES = YES
|
SHOW_NAMESPACES = YES
|
||||||
|
@ -541,12 +559,12 @@ SHOW_NAMESPACES = YES
|
||||||
|
|
||||||
FILE_VERSION_FILTER =
|
FILE_VERSION_FILTER =
|
||||||
|
|
||||||
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
|
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
|
||||||
# doxygen. The layout file controls the global structure of the generated output files
|
# by doxygen. The layout file controls the global structure of the generated
|
||||||
# in an output format independent way. The create the layout file that represents
|
# output files in an output format independent way. The create the layout file
|
||||||
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
|
# that represents doxygen's defaults, run doxygen with the -l option.
|
||||||
# file name after the option, if omitted DoxygenLayout.xml will be used as the name
|
# You can optionally specify a file name after the option, if omitted
|
||||||
# of the layout file.
|
# DoxygenLayout.xml will be used as the name of the layout file.
|
||||||
|
|
||||||
LAYOUT_FILE = ./rsc/layout.xml
|
LAYOUT_FILE = ./rsc/layout.xml
|
||||||
|
|
||||||
|
@ -578,7 +596,7 @@ WARN_IF_UNDOCUMENTED = YES
|
||||||
|
|
||||||
WARN_IF_DOC_ERROR = YES
|
WARN_IF_DOC_ERROR = YES
|
||||||
|
|
||||||
# This WARN_NO_PARAMDOC option can be abled to get warnings for
|
# The WARN_NO_PARAMDOC option can be enabled to get warnings for
|
||||||
# functions that are documented, but have no documentation for their parameters
|
# functions that are documented, but have no documentation for their parameters
|
||||||
# or return value. If set to NO (the default) doxygen will only warn about
|
# or return value. If set to NO (the default) doxygen will only warn about
|
||||||
# wrong or incomplete parameter documentation, but not about the absence of
|
# wrong or incomplete parameter documentation, but not about the absence of
|
||||||
|
@ -668,8 +686,9 @@ INPUT_ENCODING = UTF-8
|
||||||
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
||||||
# and *.h) to filter out the source-files in the directories. If left
|
# and *.h) to filter out the source-files in the directories. If left
|
||||||
# blank the following patterns are tested:
|
# blank the following patterns are tested:
|
||||||
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
|
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
|
||||||
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
|
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
|
||||||
|
# *.f90 *.f *.for *.vhd *.vhdl
|
||||||
|
|
||||||
FILE_PATTERNS = *.c \
|
FILE_PATTERNS = *.c \
|
||||||
*.cc \
|
*.cc \
|
||||||
|
@ -720,7 +739,7 @@ EXCLUDE = ../os/hal/platforms/STM32/stm32f10x.h \
|
||||||
../os/hal/platforms/LPC13xx/system_LPC13xx.h
|
../os/hal/platforms/LPC13xx/system_LPC13xx.h
|
||||||
|
|
||||||
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
|
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
|
||||||
# directories that are symbolic links (a Unix filesystem feature) are excluded
|
# directories that are symbolic links (a Unix file system feature) are excluded
|
||||||
# from the input.
|
# from the input.
|
||||||
|
|
||||||
EXCLUDE_SYMLINKS = NO
|
EXCLUDE_SYMLINKS = NO
|
||||||
|
@ -772,17 +791,20 @@ IMAGE_PATH = ./rsc
|
||||||
# by executing (via popen()) the command <filter> <input-file>, where <filter>
|
# by executing (via popen()) the command <filter> <input-file>, where <filter>
|
||||||
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
|
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
|
||||||
# input file. Doxygen will then use the output that the filter program writes
|
# input file. Doxygen will then use the output that the filter program writes
|
||||||
# to standard output. If FILTER_PATTERNS is specified, this tag will be
|
# to standard output.
|
||||||
|
# If FILTER_PATTERNS is specified, this tag will be
|
||||||
# ignored.
|
# ignored.
|
||||||
|
|
||||||
INPUT_FILTER =
|
INPUT_FILTER =
|
||||||
|
|
||||||
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
|
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
|
||||||
# basis. Doxygen will compare the file name with each pattern and apply the
|
# basis.
|
||||||
# filter if there is a match. The filters are a list of the form:
|
# Doxygen will compare the file name with each pattern and apply the
|
||||||
|
# filter if there is a match.
|
||||||
|
# The filters are a list of the form:
|
||||||
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
|
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
|
||||||
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
|
# info on how filters are used. If FILTER_PATTERNS is empty or if
|
||||||
# is applied to all files.
|
# non of the patterns match the file name, INPUT_FILTER is applied.
|
||||||
|
|
||||||
FILTER_PATTERNS =
|
FILTER_PATTERNS =
|
||||||
|
|
||||||
|
@ -792,6 +814,14 @@ FILTER_PATTERNS =
|
||||||
|
|
||||||
FILTER_SOURCE_FILES = NO
|
FILTER_SOURCE_FILES = NO
|
||||||
|
|
||||||
|
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
|
||||||
|
# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
|
||||||
|
# and it is also possible to disable source filtering for a specific pattern
|
||||||
|
# using *.ext= (so without naming a filter). This option only has effect when
|
||||||
|
# FILTER_SOURCE_FILES is enabled.
|
||||||
|
|
||||||
|
FILTER_SOURCE_PATTERNS =
|
||||||
|
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
# configuration options related to source browsing
|
# configuration options related to source browsing
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
|
@ -829,7 +859,8 @@ REFERENCES_RELATION = YES
|
||||||
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
|
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
|
||||||
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
|
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
|
||||||
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
|
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
|
||||||
# link to the source code. Otherwise they will link to the documentation.
|
# link to the source code.
|
||||||
|
# Otherwise they will link to the documentation.
|
||||||
|
|
||||||
REFERENCES_LINK_SOURCE = NO
|
REFERENCES_LINK_SOURCE = NO
|
||||||
|
|
||||||
|
@ -910,7 +941,32 @@ HTML_FOOTER = ./rsc/footer.html
|
||||||
# the style sheet file to the HTML output directory, so don't put your own
|
# the style sheet file to the HTML output directory, so don't put your own
|
||||||
# stylesheet in the HTML output directory as well, or it will be erased!
|
# stylesheet in the HTML output directory as well, or it will be erased!
|
||||||
|
|
||||||
HTML_STYLESHEET = ./rsc/custom.css
|
HTML_STYLESHEET =
|
||||||
|
|
||||||
|
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
|
||||||
|
# Doxygen will adjust the colors in the stylesheet and background images
|
||||||
|
# according to this color. Hue is specified as an angle on a colorwheel,
|
||||||
|
# see http://en.wikipedia.org/wiki/Hue for more information.
|
||||||
|
# For instance the value 0 represents red, 60 is yellow, 120 is green,
|
||||||
|
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
|
||||||
|
# The allowed range is 0 to 359.
|
||||||
|
|
||||||
|
HTML_COLORSTYLE_HUE = 220
|
||||||
|
|
||||||
|
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
|
||||||
|
# the colors in the HTML output. For a value of 0 the output will use
|
||||||
|
# grayscales only. A value of 255 will produce the most vivid colors.
|
||||||
|
|
||||||
|
HTML_COLORSTYLE_SAT = 100
|
||||||
|
|
||||||
|
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
|
||||||
|
# the luminance component of the colors in the HTML output. Values below
|
||||||
|
# 100 gradually make the output lighter, whereas values above 100 make
|
||||||
|
# the output darker. The value divided by 100 is the actual gamma applied,
|
||||||
|
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
|
||||||
|
# and 100 does not change the gamma.
|
||||||
|
|
||||||
|
HTML_COLORSTYLE_GAMMA = 80
|
||||||
|
|
||||||
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
|
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
|
||||||
# page will contain the date and time when the page was generated. Setting
|
# page will contain the date and time when the page was generated. Setting
|
||||||
|
@ -940,7 +996,8 @@ HTML_DYNAMIC_SECTIONS = NO
|
||||||
# directory and running "make install" will install the docset in
|
# directory and running "make install" will install the docset in
|
||||||
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
|
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
|
||||||
# it at startup.
|
# it at startup.
|
||||||
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
|
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
|
||||||
|
# for more information.
|
||||||
|
|
||||||
GENERATE_DOCSET = NO
|
GENERATE_DOCSET = NO
|
||||||
|
|
||||||
|
@ -958,6 +1015,16 @@ DOCSET_FEEDNAME = "Doxygen generated docs"
|
||||||
|
|
||||||
DOCSET_BUNDLE_ID = org.doxygen.Project
|
DOCSET_BUNDLE_ID = org.doxygen.Project
|
||||||
|
|
||||||
|
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
|
||||||
|
# the documentation publisher. This should be a reverse domain-name style
|
||||||
|
# string, e.g. com.mycompany.MyDocSet.documentation.
|
||||||
|
|
||||||
|
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
|
||||||
|
|
||||||
|
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
|
||||||
|
|
||||||
|
DOCSET_PUBLISHER_NAME = Publisher
|
||||||
|
|
||||||
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
|
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
|
||||||
# will be generated that can be used as input for tools like the
|
# will be generated that can be used as input for tools like the
|
||||||
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
|
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
|
||||||
|
@ -1002,10 +1069,10 @@ BINARY_TOC = NO
|
||||||
|
|
||||||
TOC_EXPAND = NO
|
TOC_EXPAND = NO
|
||||||
|
|
||||||
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
|
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
|
||||||
# are set, an additional index file will be generated that can be used as input for
|
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
|
||||||
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
|
# that can be used as input for Qt's qhelpgenerator to generate a
|
||||||
# HTML documentation.
|
# Qt Compressed Help (.qch) of the generated HTML documentation.
|
||||||
|
|
||||||
GENERATE_QHP = NO
|
GENERATE_QHP = NO
|
||||||
|
|
||||||
|
@ -1027,20 +1094,24 @@ QHP_NAMESPACE = org.doxygen.Project
|
||||||
|
|
||||||
QHP_VIRTUAL_FOLDER = doc
|
QHP_VIRTUAL_FOLDER = doc
|
||||||
|
|
||||||
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
|
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
|
||||||
# For more information please see
|
# add. For more information please see
|
||||||
# http://doc.trolltech.com/qthelpproject.html#custom-filters
|
# http://doc.trolltech.com/qthelpproject.html#custom-filters
|
||||||
|
|
||||||
QHP_CUST_FILTER_NAME =
|
QHP_CUST_FILTER_NAME =
|
||||||
|
|
||||||
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
|
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
|
||||||
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
|
# custom filter to add. For more information please see
|
||||||
|
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
|
||||||
|
# Qt Help Project / Custom Filters</a>.
|
||||||
|
|
||||||
QHP_CUST_FILTER_ATTRS =
|
QHP_CUST_FILTER_ATTRS =
|
||||||
|
|
||||||
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
|
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
|
||||||
|
# project's
|
||||||
# filter section matches.
|
# filter section matches.
|
||||||
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
|
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
|
||||||
|
# Qt Help Project / Filter Attributes</a>.
|
||||||
|
|
||||||
QHP_SECT_FILTER_ATTRS =
|
QHP_SECT_FILTER_ATTRS =
|
||||||
|
|
||||||
|
@ -1052,7 +1123,7 @@ QHP_SECT_FILTER_ATTRS =
|
||||||
QHG_LOCATION =
|
QHG_LOCATION =
|
||||||
|
|
||||||
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
|
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
|
||||||
# will be generated, which together with the HTML files, form an Eclipse help
|
# will be generated, which together with the HTML files, form an Eclipse help
|
||||||
# plugin. To install this plugin and make it available under the help contents
|
# plugin. To install this plugin and make it available under the help contents
|
||||||
# menu in Eclipse, the contents of the directory containing the HTML and XML
|
# menu in Eclipse, the contents of the directory containing the HTML and XML
|
||||||
# files needs to be copied into the plugins directory of eclipse. The name of
|
# files needs to be copied into the plugins directory of eclipse. The name of
|
||||||
|
@ -1074,8 +1145,9 @@ ECLIPSE_DOC_ID = org.doxygen.Project
|
||||||
|
|
||||||
DISABLE_INDEX = NO
|
DISABLE_INDEX = NO
|
||||||
|
|
||||||
# This tag can be used to set the number of enum values (range [1..20])
|
# This tag can be used to set the number of enum values (range [0,1..20])
|
||||||
# that doxygen will group on one line in the generated HTML documentation.
|
# that doxygen will group on one line in the generated HTML documentation.
|
||||||
|
# Note that a value of 0 will completely suppress the enum values from appearing in the overview section.
|
||||||
|
|
||||||
ENUM_VALUES_PER_LINE = 4
|
ENUM_VALUES_PER_LINE = 4
|
||||||
|
|
||||||
|
@ -1100,6 +1172,11 @@ USE_INLINE_TREES = NO
|
||||||
|
|
||||||
TREEVIEW_WIDTH = 250
|
TREEVIEW_WIDTH = 250
|
||||||
|
|
||||||
|
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
|
||||||
|
# links to external symbols imported via tag files in a separate window.
|
||||||
|
|
||||||
|
EXT_LINKS_IN_WINDOW = NO
|
||||||
|
|
||||||
# Use this tag to change the font size of Latex formulas included
|
# Use this tag to change the font size of Latex formulas included
|
||||||
# as images in the HTML documentation. The default is 10. Note that
|
# as images in the HTML documentation. The default is 10. Note that
|
||||||
# when you change the font size after a successful doxygen run you need
|
# when you change the font size after a successful doxygen run you need
|
||||||
|
@ -1108,6 +1185,33 @@ TREEVIEW_WIDTH = 250
|
||||||
|
|
||||||
FORMULA_FONTSIZE = 10
|
FORMULA_FONTSIZE = 10
|
||||||
|
|
||||||
|
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
|
||||||
|
# generated for formulas are transparent PNGs. Transparent PNGs are
|
||||||
|
# not supported properly for IE 6.0, but are supported on all modern browsers.
|
||||||
|
# Note that when changing this option you need to delete any form_*.png files
|
||||||
|
# in the HTML output before the changes have effect.
|
||||||
|
|
||||||
|
FORMULA_TRANSPARENT = YES
|
||||||
|
|
||||||
|
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
|
||||||
|
# (see http://www.mathjax.org) which uses client side Javascript for the
|
||||||
|
# rendering instead of using prerendered bitmaps. Use this if you do not
|
||||||
|
# have LaTeX installed or if you want to formulas look prettier in the HTML
|
||||||
|
# output. When enabled you also need to install MathJax separately and
|
||||||
|
# configure the path to it using the MATHJAX_RELPATH option.
|
||||||
|
|
||||||
|
USE_MATHJAX = NO
|
||||||
|
|
||||||
|
# When MathJax is enabled you need to specify the location relative to the
|
||||||
|
# HTML output directory using the MATHJAX_RELPATH option. The destination
|
||||||
|
# directory should contain the MathJax.js script. For instance, if the mathjax
|
||||||
|
# directory is located at the same level as the HTML output directory, then
|
||||||
|
# MATHJAX_RELPATH should be ../mathjax. The default value points to the mathjax.org site, so you can quickly see the result without installing
|
||||||
|
# MathJax, but it is strongly recommended to install a local copy of MathJax
|
||||||
|
# before deployment.
|
||||||
|
|
||||||
|
MATHJAX_RELPATH = http://www.mathjax.org/mathjax
|
||||||
|
|
||||||
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
|
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
|
||||||
# for the HTML output. The underlying search engine uses javascript
|
# for the HTML output. The underlying search engine uses javascript
|
||||||
# and DHTML and should work on any modern browser. Note that when using
|
# and DHTML and should work on any modern browser. Note that when using
|
||||||
|
@ -1123,7 +1227,7 @@ SEARCHENGINE = NO
|
||||||
# using Javascript. Doxygen will generate the search PHP script and index
|
# using Javascript. Doxygen will generate the search PHP script and index
|
||||||
# file to put on the web server. The advantage of the server
|
# file to put on the web server. The advantage of the server
|
||||||
# based approach is that it scales better to large projects and allows
|
# based approach is that it scales better to large projects and allows
|
||||||
# full text search. The disadvances is that it is more difficult to setup
|
# full text search. The disadvantages are that it is more difficult to setup
|
||||||
# and does not have live searching capabilities.
|
# and does not have live searching capabilities.
|
||||||
|
|
||||||
SERVER_BASED_SEARCH = NO
|
SERVER_BASED_SEARCH = NO
|
||||||
|
@ -1164,7 +1268,7 @@ MAKEINDEX_CMD_NAME = makeindex
|
||||||
COMPACT_LATEX = NO
|
COMPACT_LATEX = NO
|
||||||
|
|
||||||
# The PAPER_TYPE tag can be used to set the paper type that is used
|
# The PAPER_TYPE tag can be used to set the paper type that is used
|
||||||
# by the printer. Possible values are: a4, a4wide, letter, legal and
|
# by the printer. Possible values are: a4, letter, legal and
|
||||||
# executive. If left blank a4wide will be used.
|
# executive. If left blank a4wide will be used.
|
||||||
|
|
||||||
PAPER_TYPE = a4wide
|
PAPER_TYPE = a4wide
|
||||||
|
@ -1350,8 +1454,10 @@ GENERATE_PERLMOD = NO
|
||||||
PERLMOD_LATEX = NO
|
PERLMOD_LATEX = NO
|
||||||
|
|
||||||
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
|
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
|
||||||
# nicely formatted so it can be parsed by a human reader. This is useful
|
# nicely formatted so it can be parsed by a human reader.
|
||||||
# if you want to understand what is going on. On the other hand, if this
|
# This is useful
|
||||||
|
# if you want to understand what is going on.
|
||||||
|
# On the other hand, if this
|
||||||
# tag is set to NO the size of the Perl module output will be much smaller
|
# tag is set to NO the size of the Perl module output will be much smaller
|
||||||
# and Perl will parse it just the same.
|
# and Perl will parse it just the same.
|
||||||
|
|
||||||
|
@ -1413,43 +1519,19 @@ INCLUDE_FILE_PATTERNS =
|
||||||
# undefined via #undef or recursively expanded use the := operator
|
# undefined via #undef or recursively expanded use the := operator
|
||||||
# instead of the = operator.
|
# instead of the = operator.
|
||||||
|
|
||||||
PREDEFINED = __DOXYGEN__ \
|
PREDEFINED = __DOXYGEN__
|
||||||
CH_USE_WAITEXIT=1 \
|
|
||||||
CH_USE_SEMAPHORES=1 \
|
|
||||||
CH_USE_SEMSW=1 \
|
|
||||||
CH_USE_MUTEXES=1 \
|
|
||||||
CH_USE_CONDVARS=1 \
|
|
||||||
CH_USE_CONDVARS_TIMEOUT=1 \
|
|
||||||
CH_USE_EVENTS=1 \
|
|
||||||
CH_USE_EVENTS_TIMEOUT=1 \
|
|
||||||
CH_USE_QUEUES=1 \
|
|
||||||
CH_USE_MEMCORE=1 \
|
|
||||||
CH_USE_HEAP=1 \
|
|
||||||
CH_USE_MEMPOOLS=1 \
|
|
||||||
CH_USE_MESSAGES=1 \
|
|
||||||
CH_USE_MAILBOXES=1 \
|
|
||||||
CH_USE_DYNAMIC=1 \
|
|
||||||
CH_USE_REGISTRY=1 \
|
|
||||||
CH_DBG_ENABLE_ASSERTS=1 \
|
|
||||||
CH_DBG_ENABLE_CHECKS=1 \
|
|
||||||
CH_DBG_ENABLE_TRACE=1 \
|
|
||||||
CH_DBG_ENABLE_STACK_CHECK=1 \
|
|
||||||
CH_DBG_FILL_THREADS=1 \
|
|
||||||
CH_DBG_THREADS_PROFILING=1 \
|
|
||||||
CH_USE_ROUNDROBIN=1
|
|
||||||
|
|
||||||
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
|
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
|
||||||
# this tag can be used to specify a list of macro names that should be expanded.
|
# this tag can be used to specify a list of macro names that should be expanded.
|
||||||
# The macro definition that is found in the sources will be used.
|
# The macro definition that is found in the sources will be used.
|
||||||
# Use the PREDEFINED tag if you want to use a different macro definition.
|
# Use the PREDEFINED tag if you want to use a different macro definition that overrules the definition found in the source code.
|
||||||
|
|
||||||
EXPAND_AS_DEFINED =
|
EXPAND_AS_DEFINED =
|
||||||
|
|
||||||
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
|
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
|
||||||
# doxygen's preprocessor will remove all function-like macros that are alone
|
# doxygen's preprocessor will remove all references to function-like macros
|
||||||
# on a line, have an all uppercase name, and do not end with a semicolon. Such
|
# that are alone on a line, have an all uppercase name, and do not end with a
|
||||||
# function macros are typically used for boiler-plate code, and will confuse
|
# semicolon, because these will confuse the parser if not removed.
|
||||||
# the parser if not removed.
|
|
||||||
|
|
||||||
SKIP_FUNCTION_MACROS = NO
|
SKIP_FUNCTION_MACROS = NO
|
||||||
|
|
||||||
|
@ -1461,9 +1543,11 @@ SKIP_FUNCTION_MACROS = NO
|
||||||
# Optionally an initial location of the external documentation
|
# Optionally an initial location of the external documentation
|
||||||
# can be added for each tagfile. The format of a tag file without
|
# can be added for each tagfile. The format of a tag file without
|
||||||
# this location is as follows:
|
# this location is as follows:
|
||||||
# TAGFILES = file1 file2 ...
|
#
|
||||||
|
# TAGFILES = file1 file2 ...
|
||||||
# Adding location for the tag files is done as follows:
|
# Adding location for the tag files is done as follows:
|
||||||
# TAGFILES = file1=loc1 "file2 = loc2" ...
|
#
|
||||||
|
# TAGFILES = file1=loc1 "file2 = loc2" ...
|
||||||
# where "loc1" and "loc2" can be relative or absolute paths or
|
# where "loc1" and "loc2" can be relative or absolute paths or
|
||||||
# URLs. If a location is present for each tag, the installdox tool
|
# URLs. If a location is present for each tag, the installdox tool
|
||||||
# does not have to be run to correct the links.
|
# does not have to be run to correct the links.
|
||||||
|
@ -1503,9 +1587,8 @@ PERL_PATH = /usr/bin/perl
|
||||||
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
|
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
|
||||||
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
|
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
|
||||||
# or super classes. Setting the tag to NO turns the diagrams off. Note that
|
# or super classes. Setting the tag to NO turns the diagrams off. Note that
|
||||||
# this option is superseded by the HAVE_DOT option below. This is only a
|
# this option also works with HAVE_DOT disabled, but it is recommended to
|
||||||
# fallback. It is recommended to install and use dot, since it yields more
|
# install and use dot, since it yields more powerful graphs.
|
||||||
# powerful graphs.
|
|
||||||
|
|
||||||
CLASS_DIAGRAMS = NO
|
CLASS_DIAGRAMS = NO
|
||||||
|
|
||||||
|
@ -1531,11 +1614,18 @@ HIDE_UNDOC_RELATIONS = YES
|
||||||
|
|
||||||
HAVE_DOT = YES
|
HAVE_DOT = YES
|
||||||
|
|
||||||
# By default doxygen will write a font called FreeSans.ttf to the output
|
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
|
||||||
# directory and reference it in all dot files that doxygen generates. This
|
# allowed to run in parallel. When set to 0 (the default) doxygen will
|
||||||
# font does not include all possible unicode characters however, so when you need
|
# base this on the number of processors available in the system. You can set it
|
||||||
# these (or just want a differently looking font) you can specify the font name
|
# explicitly to a value larger than 0 to get control over the balance
|
||||||
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
|
# between CPU load and processing speed.
|
||||||
|
|
||||||
|
DOT_NUM_THREADS = 0
|
||||||
|
|
||||||
|
# By default doxygen will write a font called Helvetica to the output
|
||||||
|
# directory and reference it in all dot files that doxygen generates.
|
||||||
|
# When you want a differently looking font you can specify the font name
|
||||||
|
# using DOT_FONTNAME. You need to make sure dot is able to find the font,
|
||||||
# which can be done by putting it in a standard location or by setting the
|
# which can be done by putting it in a standard location or by setting the
|
||||||
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
|
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
|
||||||
# containing the font.
|
# containing the font.
|
||||||
|
@ -1615,7 +1705,7 @@ CALL_GRAPH = YES
|
||||||
CALLER_GRAPH = NO
|
CALLER_GRAPH = NO
|
||||||
|
|
||||||
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
|
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
|
||||||
# will graphical hierarchy of all classes instead of a textual one.
|
# will generate a graphical hierarchy of all classes instead of a textual one.
|
||||||
|
|
||||||
GRAPHICAL_HIERARCHY = YES
|
GRAPHICAL_HIERARCHY = YES
|
||||||
|
|
||||||
|
@ -1627,7 +1717,7 @@ GRAPHICAL_HIERARCHY = YES
|
||||||
DIRECTORY_GRAPH = NO
|
DIRECTORY_GRAPH = NO
|
||||||
|
|
||||||
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
||||||
# generated by dot. Possible values are png, jpg, or gif
|
# generated by dot. Possible values are png, svg, gif or svg.
|
||||||
# If left blank png will be used.
|
# If left blank png will be used.
|
||||||
|
|
||||||
DOT_IMAGE_FORMAT = png
|
DOT_IMAGE_FORMAT = png
|
||||||
|
@ -1643,6 +1733,12 @@ DOT_PATH =
|
||||||
|
|
||||||
DOTFILE_DIRS =
|
DOTFILE_DIRS =
|
||||||
|
|
||||||
|
# The MSCFILE_DIRS tag can be used to specify one or more directories that
|
||||||
|
# contain msc files that are included in the documentation (see the
|
||||||
|
# \mscfile command).
|
||||||
|
|
||||||
|
MSCFILE_DIRS =
|
||||||
|
|
||||||
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
|
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
|
||||||
# nodes that will be shown in the graph. If the number of nodes in a graph
|
# nodes that will be shown in the graph. If the number of nodes in a graph
|
||||||
# becomes larger than this value, doxygen will truncate the graph, which is
|
# becomes larger than this value, doxygen will truncate the graph, which is
|
||||||
|
|
|
@ -6,9 +6,9 @@ order to access directly the doxigen documentation.
|
||||||
*** Documentation build procedure ***
|
*** Documentation build procedure ***
|
||||||
|
|
||||||
The following software must be installed:
|
The following software must be installed:
|
||||||
- Doxygen 1.6.3 or later.
|
- Doxygen 1.7.3 or later.
|
||||||
- Graphviz 2.21 or later. The ./bin directory must be specified in the path in
|
- Graphviz 2.26.3 or later. The ./bin directory must be specified in the path
|
||||||
order to make Graphviz accessible by Doxygen.
|
in order to make Graphviz accessible by Doxygen.
|
||||||
|
|
||||||
Build procedure:
|
Build procedure:
|
||||||
- Run Doxywizard.
|
- Run Doxywizard.
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
/* The standard CSS for doxygen */
|
||||||
|
|
||||||
body, table, div, p, dl {
|
body, table, div, p, dl {
|
||||||
font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
|
font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
|
||||||
font-size: 12px;
|
font-size: 12px;
|
||||||
|
@ -6,7 +8,6 @@ body, table, div, p, dl {
|
||||||
/* @group Heading Levels */
|
/* @group Heading Levels */
|
||||||
|
|
||||||
h1 {
|
h1 {
|
||||||
text-align: center;
|
|
||||||
font-size: 150%;
|
font-size: 150%;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -18,15 +19,52 @@ h3 {
|
||||||
font-size: 100%;
|
font-size: 100%;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
dt {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.multicol {
|
||||||
|
-moz-column-gap: 1em;
|
||||||
|
-webkit-column-gap: 1em;
|
||||||
|
-moz-column-count: 3;
|
||||||
|
-webkit-column-count: 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
p.startli, p.startdd, p.starttd {
|
||||||
|
margin-top: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
p.endli {
|
||||||
|
margin-bottom: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
p.enddd {
|
||||||
|
margin-bottom: 4px;
|
||||||
|
}
|
||||||
|
|
||||||
|
p.endtd {
|
||||||
|
margin-bottom: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
/* @end */
|
/* @end */
|
||||||
|
|
||||||
caption {
|
caption {
|
||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
}
|
}
|
||||||
|
|
||||||
div.qindex, div.navpath, div.navtab{
|
span.legend {
|
||||||
background-color: #e8eef2;
|
font-size: 70%;
|
||||||
border: 1px solid #84b0c7;
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
h3.version {
|
||||||
|
font-size: 90%;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.qindex, div.navtab{
|
||||||
|
background-color: #EBEFF6;
|
||||||
|
border: 1px solid #A3B4D7;
|
||||||
text-align: center;
|
text-align: center;
|
||||||
margin: 2px;
|
margin: 2px;
|
||||||
padding: 2px;
|
padding: 2px;
|
||||||
|
@ -44,13 +82,13 @@ div.navtab {
|
||||||
/* @group Link Styling */
|
/* @group Link Styling */
|
||||||
|
|
||||||
a {
|
a {
|
||||||
color: #153788;
|
color: #3D578C;
|
||||||
font-weight: normal;
|
font-weight: normal;
|
||||||
text-decoration: none;
|
text-decoration: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
.contents a:visited {
|
.contents a:visited {
|
||||||
color: #1b77c5;
|
color: #4665A2;
|
||||||
}
|
}
|
||||||
|
|
||||||
a:hover {
|
a:hover {
|
||||||
|
@ -63,9 +101,13 @@ a.qindex {
|
||||||
|
|
||||||
a.qindexHL {
|
a.qindexHL {
|
||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
background-color: #6666cc;
|
background-color: #9CAFD4;
|
||||||
color: #ffffff;
|
color: #ffffff;
|
||||||
border: 1px double #9295C2;
|
border: 1px double #869DCA;
|
||||||
|
}
|
||||||
|
|
||||||
|
.contents a.qindexHL:visited {
|
||||||
|
color: #ffffff;
|
||||||
}
|
}
|
||||||
|
|
||||||
a.el {
|
a.el {
|
||||||
|
@ -76,9 +118,11 @@ a.elRef {
|
||||||
}
|
}
|
||||||
|
|
||||||
a.code {
|
a.code {
|
||||||
|
color: #4665A2;
|
||||||
}
|
}
|
||||||
|
|
||||||
a.codeRef {
|
a.codeRef {
|
||||||
|
color: #4665A2;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* @end */
|
/* @end */
|
||||||
|
@ -93,10 +137,14 @@ dl.el {
|
||||||
}
|
}
|
||||||
|
|
||||||
pre.fragment {
|
pre.fragment {
|
||||||
border: 1px solid #CCCCCC;
|
border: 1px solid #C4CFE5;
|
||||||
background-color: #f5f5f5;
|
background-color: #FBFCFD;
|
||||||
padding: 4px 6px;
|
padding: 4px 6px;
|
||||||
margin: 4px 8px 4px 2px;
|
margin: 4px 8px 4px 2px;
|
||||||
|
overflow: auto;
|
||||||
|
word-wrap: break-word;
|
||||||
|
font-size: 9pt;
|
||||||
|
line-height: 125%;
|
||||||
}
|
}
|
||||||
|
|
||||||
div.ah {
|
div.ah {
|
||||||
|
@ -104,13 +152,22 @@ div.ah {
|
||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
color: #ffffff;
|
color: #ffffff;
|
||||||
margin-bottom: 3px;
|
margin-bottom: 3px;
|
||||||
margin-top: 3px
|
margin-top: 3px;
|
||||||
|
padding: 0.2em;
|
||||||
|
border: solid thin #333;
|
||||||
|
border-radius: 0.5em;
|
||||||
|
-webkit-border-radius: .5em;
|
||||||
|
-moz-border-radius: .5em;
|
||||||
|
box-shadow: 2px 2px 3px #999;
|
||||||
|
-webkit-box-shadow: 2px 2px 3px #999;
|
||||||
|
-moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
|
||||||
|
background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444));
|
||||||
|
background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000);
|
||||||
}
|
}
|
||||||
|
|
||||||
div.groupHeader {
|
div.groupHeader {
|
||||||
margin-left: 16px;
|
margin-left: 16px;
|
||||||
margin-top: 12px;
|
margin-top: 12px;
|
||||||
margin-bottom: 6px;
|
|
||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -122,27 +179,32 @@ div.groupText {
|
||||||
body {
|
body {
|
||||||
background: white;
|
background: white;
|
||||||
color: black;
|
color: black;
|
||||||
margin-right: 20px;
|
margin: 0;
|
||||||
margin-left: 20px;
|
}
|
||||||
|
|
||||||
|
div.contents {
|
||||||
|
margin-top: 10px;
|
||||||
|
margin-left: 10px;
|
||||||
|
margin-right: 10px;
|
||||||
}
|
}
|
||||||
|
|
||||||
td.indexkey {
|
td.indexkey {
|
||||||
background-color: #e8eef2;
|
background-color: #EBEFF6;
|
||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
border: 1px solid #CCCCCC;
|
border: 1px solid #C4CFE5;
|
||||||
margin: 2px 0px 2px 0;
|
margin: 2px 0px 2px 0;
|
||||||
padding: 2px 10px;
|
padding: 2px 10px;
|
||||||
}
|
}
|
||||||
|
|
||||||
td.indexvalue {
|
td.indexvalue {
|
||||||
background-color: #e8eef2;
|
background-color: #EBEFF6;
|
||||||
border: 1px solid #CCCCCC;
|
border: 1px solid #C4CFE5;
|
||||||
padding: 2px 10px;
|
padding: 2px 10px;
|
||||||
margin: 2px 0px;
|
margin: 2px 0px;
|
||||||
}
|
}
|
||||||
|
|
||||||
tr.memlist {
|
tr.memlist {
|
||||||
background-color: #f0f0f0;
|
background-color: #EEF1F7;
|
||||||
}
|
}
|
||||||
|
|
||||||
p.formulaDsp {
|
p.formulaDsp {
|
||||||
|
@ -157,6 +219,27 @@ img.formulaInl {
|
||||||
vertical-align: middle;
|
vertical-align: middle;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
div.center {
|
||||||
|
text-align: center;
|
||||||
|
margin-top: 0px;
|
||||||
|
margin-bottom: 0px;
|
||||||
|
padding: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.center img {
|
||||||
|
border: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
address.footer {
|
||||||
|
text-align: right;
|
||||||
|
padding-right: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
img.footer {
|
||||||
|
border: 0px;
|
||||||
|
vertical-align: middle;
|
||||||
|
}
|
||||||
|
|
||||||
/* @group Code Colorization */
|
/* @group Code Colorization */
|
||||||
|
|
||||||
span.keyword {
|
span.keyword {
|
||||||
|
@ -205,6 +288,7 @@ span.vhdllogic {
|
||||||
|
|
||||||
/* @end */
|
/* @end */
|
||||||
|
|
||||||
|
/*
|
||||||
.search {
|
.search {
|
||||||
color: #003399;
|
color: #003399;
|
||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
|
@ -221,6 +305,7 @@ input.search {
|
||||||
font-weight: normal;
|
font-weight: normal;
|
||||||
background-color: #e8eef2;
|
background-color: #e8eef2;
|
||||||
}
|
}
|
||||||
|
*/
|
||||||
|
|
||||||
td.tiny {
|
td.tiny {
|
||||||
font-size: 75%;
|
font-size: 75%;
|
||||||
|
@ -229,26 +314,35 @@ td.tiny {
|
||||||
.dirtab {
|
.dirtab {
|
||||||
padding: 4px;
|
padding: 4px;
|
||||||
border-collapse: collapse;
|
border-collapse: collapse;
|
||||||
border: 1px solid #84b0c7;
|
border: 1px solid #A3B4D7;
|
||||||
}
|
}
|
||||||
|
|
||||||
th.dirtab {
|
th.dirtab {
|
||||||
background: #e8eef2;
|
background: #EBEFF6;
|
||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
}
|
}
|
||||||
|
|
||||||
hr {
|
hr {
|
||||||
height: 0;
|
height: 0px;
|
||||||
border: none;
|
border: none;
|
||||||
border-top: 1px solid #666;
|
border-top: 1px solid #4A6AAA;
|
||||||
|
}
|
||||||
|
|
||||||
|
hr.footer {
|
||||||
|
height: 1px;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* @group Member Descriptions */
|
/* @group Member Descriptions */
|
||||||
|
|
||||||
|
table.memberdecls {
|
||||||
|
border-spacing: 0px;
|
||||||
|
padding: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
.mdescLeft, .mdescRight,
|
.mdescLeft, .mdescRight,
|
||||||
.memItemLeft, .memItemRight,
|
.memItemLeft, .memItemRight,
|
||||||
.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
|
.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
|
||||||
background-color: #FAFAFA;
|
background-color: #F9FAFC;
|
||||||
border: none;
|
border: none;
|
||||||
margin: 4px;
|
margin: 4px;
|
||||||
padding: 1px 0 0 8px;
|
padding: 1px 0 0 8px;
|
||||||
|
@ -260,11 +354,16 @@ hr {
|
||||||
}
|
}
|
||||||
|
|
||||||
.memItemLeft, .memItemRight, .memTemplParams {
|
.memItemLeft, .memItemRight, .memTemplParams {
|
||||||
border-top: 1px solid #ccc;
|
border-top: 1px solid #C4CFE5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.memItemLeft, .memTemplItemLeft {
|
||||||
|
white-space: nowrap;
|
||||||
}
|
}
|
||||||
|
|
||||||
.memTemplParams {
|
.memTemplParams {
|
||||||
color: #606060;
|
color: #4665A2;
|
||||||
|
white-space: nowrap;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* @end */
|
/* @end */
|
||||||
|
@ -275,14 +374,14 @@ hr {
|
||||||
|
|
||||||
.memtemplate {
|
.memtemplate {
|
||||||
font-size: 80%;
|
font-size: 80%;
|
||||||
color: #606060;
|
color: #4665A2;
|
||||||
font-weight: normal;
|
font-weight: normal;
|
||||||
margin-left: 3px;
|
margin-left: 9px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.memnav {
|
.memnav {
|
||||||
background-color: #e8eef2;
|
background-color: #EBEFF6;
|
||||||
border: 1px solid #84b0c7;
|
border: 1px solid #A3B4D7;
|
||||||
text-align: center;
|
text-align: center;
|
||||||
margin: 2px;
|
margin: 2px;
|
||||||
margin-right: 15px;
|
margin-right: 15px;
|
||||||
|
@ -291,39 +390,62 @@ hr {
|
||||||
|
|
||||||
.memitem {
|
.memitem {
|
||||||
padding: 0;
|
padding: 0;
|
||||||
|
margin-bottom: 10px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.memname {
|
.memname {
|
||||||
white-space: nowrap;
|
white-space: nowrap;
|
||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
}
|
margin-left: 6px;
|
||||||
|
|
||||||
.memproto, .memdoc {
|
|
||||||
border: 1px solid #84b0c7;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
.memproto {
|
.memproto {
|
||||||
padding: 0;
|
border-top: 1px solid #A8B8D9;
|
||||||
background-color: #d5e1e8;
|
border-left: 1px solid #A8B8D9;
|
||||||
font-weight: bold;
|
border-right: 1px solid #A8B8D9;
|
||||||
-webkit-border-top-left-radius: 8px;
|
padding: 6px 0px 6px 0px;
|
||||||
-webkit-border-top-right-radius: 8px;
|
color: #253555;
|
||||||
-moz-border-radius-topleft: 8px;
|
font-weight: bold;
|
||||||
-moz-border-radius-topright: 8px;
|
text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
|
||||||
|
/* opera specific markup */
|
||||||
|
box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
|
||||||
|
border-top-right-radius: 8px;
|
||||||
|
border-top-left-radius: 8px;
|
||||||
|
/* firefox specific markup */
|
||||||
|
-moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
|
||||||
|
-moz-border-radius-topright: 8px;
|
||||||
|
-moz-border-radius-topleft: 8px;
|
||||||
|
/* webkit specific markup */
|
||||||
|
-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
|
||||||
|
-webkit-border-top-right-radius: 8px;
|
||||||
|
-webkit-border-top-left-radius: 8px;
|
||||||
|
background-image:url('nav_f.png');
|
||||||
|
background-repeat:repeat-x;
|
||||||
|
background-color: #E2E8F2;
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
.memdoc {
|
.memdoc {
|
||||||
padding: 2px 5px;
|
border-bottom: 1px solid #A8B8D9;
|
||||||
background-color: #eef3f5;
|
border-left: 1px solid #A8B8D9;
|
||||||
border-top-width: 0;
|
border-right: 1px solid #A8B8D9;
|
||||||
-webkit-border-bottom-left-radius: 8px;
|
padding: 2px 5px;
|
||||||
-webkit-border-bottom-right-radius: 8px;
|
background-color: #FBFCFD;
|
||||||
-moz-border-radius-bottomleft: 8px;
|
border-top-width: 0;
|
||||||
-moz-border-radius-bottomright: 8px;
|
/* opera specific markup */
|
||||||
}
|
border-bottom-left-radius: 8px;
|
||||||
|
border-bottom-right-radius: 8px;
|
||||||
.memdoc p, .memdoc dl, .memdoc ul {
|
box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
|
||||||
margin: 6px 0;
|
/* firefox specific markup */
|
||||||
|
-moz-border-radius-bottomleft: 8px;
|
||||||
|
-moz-border-radius-bottomright: 8px;
|
||||||
|
-moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
|
||||||
|
background-image: -moz-linear-gradient(center top, #FFFFFF 0%, #FFFFFF 60%, #F7F8FB 95%, #EEF1F7);
|
||||||
|
/* webkit specific markup */
|
||||||
|
-webkit-border-bottom-left-radius: 8px;
|
||||||
|
-webkit-border-bottom-right-radius: 8px;
|
||||||
|
-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
|
||||||
|
background-image: -webkit-gradient(linear,center top,center bottom,from(#FFFFFF), color-stop(0.6,#FFFFFF), color-stop(0.60,#FFFFFF), color-stop(0.95,#F7F8FB), to(#EEF1F7));
|
||||||
}
|
}
|
||||||
|
|
||||||
.paramkey {
|
.paramkey {
|
||||||
|
@ -342,6 +464,28 @@ hr {
|
||||||
font-style: normal;
|
font-style: normal;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.params, .retval, .exception, .tparams {
|
||||||
|
border-spacing: 6px 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.params .paramname, .retval .paramname {
|
||||||
|
font-weight: bold;
|
||||||
|
vertical-align: top;
|
||||||
|
}
|
||||||
|
|
||||||
|
.params .paramtype {
|
||||||
|
font-style: italic;
|
||||||
|
vertical-align: top;
|
||||||
|
}
|
||||||
|
|
||||||
|
.params .paramdir {
|
||||||
|
font-family: "courier new",courier,monospace;
|
||||||
|
vertical-align: top;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/* @end */
|
/* @end */
|
||||||
|
|
||||||
/* @group Directory (tree) */
|
/* @group Directory (tree) */
|
||||||
|
@ -350,7 +494,7 @@ hr {
|
||||||
|
|
||||||
.ftvtree {
|
.ftvtree {
|
||||||
font-family: sans-serif;
|
font-family: sans-serif;
|
||||||
margin: 0.5em;
|
margin: 0px;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* these are for tree view when used as main index */
|
/* these are for tree view when used as main index */
|
||||||
|
@ -358,6 +502,7 @@ hr {
|
||||||
.directory {
|
.directory {
|
||||||
font-size: 9pt;
|
font-size: 9pt;
|
||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
|
margin: 5px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.directory h3 {
|
.directory h3 {
|
||||||
|
@ -435,7 +580,221 @@ proper pixel height of your image.
|
||||||
|
|
||||||
/* @end */
|
/* @end */
|
||||||
|
|
||||||
|
div.dynheader {
|
||||||
|
margin-top: 8px;
|
||||||
|
}
|
||||||
|
|
||||||
address {
|
address {
|
||||||
font-style: normal;
|
font-style: normal;
|
||||||
color: #333;
|
color: #2A3D61;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
table.doxtable {
|
||||||
|
border-collapse:collapse;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.doxtable td, table.doxtable th {
|
||||||
|
border: 1px solid #2D4068;
|
||||||
|
padding: 3px 7px 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.doxtable th {
|
||||||
|
background-color: #374F7F;
|
||||||
|
color: #FFFFFF;
|
||||||
|
font-size: 110%;
|
||||||
|
padding-bottom: 4px;
|
||||||
|
padding-top: 5px;
|
||||||
|
text-align:left;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tabsearch {
|
||||||
|
top: 0px;
|
||||||
|
left: 10px;
|
||||||
|
height: 36px;
|
||||||
|
background-image: url('tab_b.png');
|
||||||
|
z-index: 101;
|
||||||
|
overflow: hidden;
|
||||||
|
font-size: 13px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.navpath ul
|
||||||
|
{
|
||||||
|
font-size: 11px;
|
||||||
|
background-image:url('tab_b.png');
|
||||||
|
background-repeat:repeat-x;
|
||||||
|
height:30px;
|
||||||
|
line-height:30px;
|
||||||
|
color:#8AA0CC;
|
||||||
|
border:solid 1px #C2CDE4;
|
||||||
|
overflow:hidden;
|
||||||
|
margin:0px;
|
||||||
|
padding:0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.navpath li
|
||||||
|
{
|
||||||
|
list-style-type:none;
|
||||||
|
float:left;
|
||||||
|
padding-left:10px;
|
||||||
|
padding-right:15px;
|
||||||
|
background-image:url('bc_s.png');
|
||||||
|
background-repeat:no-repeat;
|
||||||
|
background-position:right;
|
||||||
|
color:#364D7C;
|
||||||
|
}
|
||||||
|
|
||||||
|
.navpath li.navelem a
|
||||||
|
{
|
||||||
|
height:32px;
|
||||||
|
display:block;
|
||||||
|
text-decoration: none;
|
||||||
|
outline: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.navpath li.navelem a:hover
|
||||||
|
{
|
||||||
|
color:#6884BD;
|
||||||
|
}
|
||||||
|
|
||||||
|
.navpath li.footer
|
||||||
|
{
|
||||||
|
list-style-type:none;
|
||||||
|
float:right;
|
||||||
|
padding-left:10px;
|
||||||
|
padding-right:15px;
|
||||||
|
background-image:none;
|
||||||
|
background-repeat:no-repeat;
|
||||||
|
background-position:right;
|
||||||
|
color:#364D7C;
|
||||||
|
font-size: 8pt;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
div.summary
|
||||||
|
{
|
||||||
|
float: right;
|
||||||
|
font-size: 8pt;
|
||||||
|
padding-right: 5px;
|
||||||
|
width: 50%;
|
||||||
|
text-align: right;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.summary a
|
||||||
|
{
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.ingroups
|
||||||
|
{
|
||||||
|
font-size: 8pt;
|
||||||
|
padding-left: 5px;
|
||||||
|
width: 50%;
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.ingroups a
|
||||||
|
{
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.header
|
||||||
|
{
|
||||||
|
background-image:url('nav_h.png');
|
||||||
|
background-repeat:repeat-x;
|
||||||
|
background-color: #F9FAFC;
|
||||||
|
margin: 0px;
|
||||||
|
border-bottom: 1px solid #C4CFE5;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.headertitle
|
||||||
|
{
|
||||||
|
padding: 5px 5px 5px 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl
|
||||||
|
{
|
||||||
|
padding: 0 0 0 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug
|
||||||
|
{
|
||||||
|
border-left:4px solid;
|
||||||
|
padding: 0 0 0 6px;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.note
|
||||||
|
{
|
||||||
|
border-color: #D0D000;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.warning, dl.attention
|
||||||
|
{
|
||||||
|
border-color: #FF0000;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.pre, dl.post, dl.invariant
|
||||||
|
{
|
||||||
|
border-color: #00D000;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.deprecated
|
||||||
|
{
|
||||||
|
border-color: #505050;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.todo
|
||||||
|
{
|
||||||
|
border-color: #00C0E0;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.test
|
||||||
|
{
|
||||||
|
border-color: #3030E0;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.bug
|
||||||
|
{
|
||||||
|
border-color: #C08050;
|
||||||
|
}
|
||||||
|
|
||||||
|
#projectlogo
|
||||||
|
{
|
||||||
|
text-align: center;
|
||||||
|
vertical-align: bottom;
|
||||||
|
border-collapse: separate;
|
||||||
|
}
|
||||||
|
|
||||||
|
#projectlogo img
|
||||||
|
{
|
||||||
|
border: 0px none;
|
||||||
|
}
|
||||||
|
|
||||||
|
#projectname
|
||||||
|
{
|
||||||
|
font: 300% arial,sans-serif;
|
||||||
|
margin: 0px;
|
||||||
|
padding: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#projectbrief
|
||||||
|
{
|
||||||
|
font: 120% arial,sans-serif;
|
||||||
|
margin: 0px;
|
||||||
|
padding: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#projectnumber
|
||||||
|
{
|
||||||
|
font: 50% arial,sans-serif;
|
||||||
|
margin: 0px;
|
||||||
|
padding: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#titlearea
|
||||||
|
{
|
||||||
|
padding: 0px;
|
||||||
|
margin: 0px;
|
||||||
|
width: 100%;
|
||||||
|
border-bottom: 1px solid #5373B4;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,7 @@
|
||||||
<hr size="1"><address style="text-align: right;"><small>
|
<li class="footer">Generated on $datetime for $projectname by
|
||||||
Generated on $datetime for $projectname by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> $doxygenversion</small></address>
|
<a href="http://www.doxygen.org/index.html">
|
||||||
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|
|
@ -1,17 +1,28 @@
|
||||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||||
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||||
<title>$title</title>
|
<title>$title</title>
|
||||||
<link href="custom.css" rel="stylesheet" type="text/css">
|
<link href="$relpath$tabs.css" rel="stylesheet" type="text/css"/>
|
||||||
<link href="tabs.css" rel="stylesheet" type="text/css">
|
<link href="$relpath$navtree.css" rel="stylesheet" type="text/css"/>
|
||||||
</head><body>
|
<script type="text/javascript" src="$relpath$jquery.js"></script>
|
||||||
<table style="text-align: center; width: 100%;" border="0"
|
<script type="text/javascript" src="$relpath$navtree.js"></script>
|
||||||
cellpadding="2" cellspacing="2">
|
<script type="text/javascript" src="$relpath$resize.js"></script>
|
||||||
<tbody>
|
<script type="text/javascript">
|
||||||
<tr>
|
$(document).ready(initResizable);
|
||||||
<td style="width: 80px;"><img alt="ChibiOS/RT Logo" src="logo_small.png"></td>
|
</script>
|
||||||
<td><big><big>ChibiOS/RT</big></big><br><br>Architecture - Reference Manual - Guides</td>
|
<link href="$relpath$doxygen.css" rel="stylesheet" type="text/css"/>
|
||||||
<td style="width: 80px;"></td>
|
</head>
|
||||||
</tr>
|
<body>
|
||||||
</tbody>
|
<div id="top"><!-- do not remove this div! -->
|
||||||
|
<div id="titlearea">
|
||||||
|
<table cellspacing="0" cellpadding="0">
|
||||||
|
<tbody>
|
||||||
|
<tr style="height: 56px;">
|
||||||
|
<td style="padding-left: 0.5em;">
|
||||||
|
<div id="projectname">ChibiOS/RT <span id="projectnumber">2.3.1</span></div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<hr size="1">
|
</div>
|
||||||
|
|
|
@ -2,24 +2,24 @@
|
||||||
<!-- Navigation index tabs for HTML output -->
|
<!-- Navigation index tabs for HTML output -->
|
||||||
<navindex>
|
<navindex>
|
||||||
<tab type="mainpage" visible="yes" title=""/>
|
<tab type="mainpage" visible="yes" title=""/>
|
||||||
<tab type="pages" visible="yes" title=""/>
|
<tab type="pages" visible="yes" title="" intro=""/>
|
||||||
<tab type="modules" visible="yes" title=""/>
|
<tab type="modules" visible="yes" title="" intro=""/>
|
||||||
<tab type="namespaces" visible="yes" title="">
|
<tab type="namespaces" visible="yes" title="">
|
||||||
<tab type="namespaces" visible="yes" title=""/>
|
<tab type="namespaces" visible="yes" title="" intro=""/>
|
||||||
<tab type="namespacemembers" visible="yes" title=""/>
|
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||||
</tab>
|
</tab>
|
||||||
<tab type="classes" visible="yes" title="">
|
<tab type="classes" visible="yes" title="">
|
||||||
<tab type="classes" visible="yes" title=""/>
|
<tab type="classes" visible="yes" title="" intro=""/>
|
||||||
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||||
<tab type="hierarchy" visible="yes" title=""/>
|
<tab type="hierarchy" visible="yes" title="" intro=""/>
|
||||||
<tab type="classmembers" visible="yes" title=""/>
|
<tab type="classmembers" visible="yes" title="" intro=""/>
|
||||||
</tab>
|
</tab>
|
||||||
<tab type="files" visible="yes" title="">
|
<tab type="files" visible="yes" title="">
|
||||||
<tab type="files" visible="yes" title=""/>
|
<tab type="files" visible="yes" title="" intro=""/>
|
||||||
<tab type="globals" visible="yes" title=""/>
|
<tab type="globals" visible="yes" title="" intro=""/>
|
||||||
</tab>
|
</tab>
|
||||||
<tab type="dirs" visible="yes" title=""/>
|
<tab type="dirs" visible="yes" title="" intro=""/>
|
||||||
<tab type="examples" visible="yes" title=""/>
|
<tab type="examples" visible="yes" title="" intro=""/>
|
||||||
</navindex>
|
</navindex>
|
||||||
|
|
||||||
<!-- Layout definition for a class page -->
|
<!-- Layout definition for a class page -->
|
||||||
|
@ -108,20 +108,20 @@
|
||||||
<memberdecl>
|
<memberdecl>
|
||||||
<classes visible="yes" title=""/>
|
<classes visible="yes" title=""/>
|
||||||
<namespaces visible="yes" title=""/>
|
<namespaces visible="yes" title=""/>
|
||||||
|
<functions title=""/>
|
||||||
|
<variables title=""/>
|
||||||
<defines title=""/>
|
<defines title=""/>
|
||||||
<typedefs title=""/>
|
<typedefs title=""/>
|
||||||
<enums title=""/>
|
<enums title=""/>
|
||||||
<functions title=""/>
|
|
||||||
<variables title=""/>
|
|
||||||
<membergroups visible="yes"/>
|
<membergroups visible="yes"/>
|
||||||
</memberdecl>
|
</memberdecl>
|
||||||
<detaileddescription title=""/>
|
<detaileddescription title=""/>
|
||||||
<memberdef>
|
<memberdef>
|
||||||
|
<functions title=""/>
|
||||||
|
<variables title=""/>
|
||||||
<defines title=""/>
|
<defines title=""/>
|
||||||
<typedefs title=""/>
|
<typedefs title=""/>
|
||||||
<enums title=""/>
|
<enums title=""/>
|
||||||
<functions title=""/>
|
|
||||||
<variables title=""/>
|
|
||||||
</memberdef>
|
</memberdef>
|
||||||
<authorsection/>
|
<authorsection/>
|
||||||
</file>
|
</file>
|
||||||
|
@ -130,15 +130,14 @@
|
||||||
<group>
|
<group>
|
||||||
<briefdescription visible="yes"/>
|
<briefdescription visible="yes"/>
|
||||||
<groupgraph visible="$GROUP_GRAPHS"/>
|
<groupgraph visible="$GROUP_GRAPHS"/>
|
||||||
<detaileddescription title="Description"/>
|
|
||||||
<memberdecl>
|
<memberdecl>
|
||||||
<classes visible="yes" title=""/>
|
<classes visible="yes" title=""/>
|
||||||
<namespaces visible="yes" title=""/>
|
<namespaces visible="yes" title=""/>
|
||||||
<dirs visible="yes" title=""/>
|
<dirs visible="yes" title=""/>
|
||||||
<nestedgroups visible="yes" title=""/>
|
<nestedgroups visible="yes" title=""/>
|
||||||
<files visible="yes" title=""/>
|
<files visible="yes" title=""/>
|
||||||
<variables title=""/>
|
|
||||||
<functions title=""/>
|
<functions title=""/>
|
||||||
|
<variables title=""/>
|
||||||
<defines title=""/>
|
<defines title=""/>
|
||||||
<typedefs title=""/>
|
<typedefs title=""/>
|
||||||
<enums title=""/>
|
<enums title=""/>
|
||||||
|
@ -152,10 +151,11 @@
|
||||||
<friends title=""/>
|
<friends title=""/>
|
||||||
<membergroups visible="yes"/>
|
<membergroups visible="yes"/>
|
||||||
</memberdecl>
|
</memberdecl>
|
||||||
|
<detaileddescription title=""/>
|
||||||
<memberdef>
|
<memberdef>
|
||||||
<pagedocs/>
|
<pagedocs/>
|
||||||
<variables title=""/>
|
|
||||||
<functions title=""/>
|
<functions title=""/>
|
||||||
|
<variables title=""/>
|
||||||
<defines title=""/>
|
<defines title=""/>
|
||||||
<typedefs title=""/>
|
<typedefs title=""/>
|
||||||
<enums title=""/>
|
<enums title=""/>
|
||||||
|
|
|
@ -1,102 +0,0 @@
|
||||||
/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */
|
|
||||||
|
|
||||||
DIV.tabs
|
|
||||||
{
|
|
||||||
float : left;
|
|
||||||
width : 100%;
|
|
||||||
background : url("tab_b.gif") repeat-x bottom;
|
|
||||||
margin-bottom : 4px;
|
|
||||||
}
|
|
||||||
|
|
||||||
DIV.tabs UL
|
|
||||||
{
|
|
||||||
margin : 0px;
|
|
||||||
padding-left : 10px;
|
|
||||||
list-style : none;
|
|
||||||
}
|
|
||||||
|
|
||||||
DIV.tabs LI, DIV.tabs FORM
|
|
||||||
{
|
|
||||||
display : inline;
|
|
||||||
margin : 0px;
|
|
||||||
padding : 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
DIV.tabs FORM
|
|
||||||
{
|
|
||||||
float : right;
|
|
||||||
}
|
|
||||||
|
|
||||||
DIV.tabs A
|
|
||||||
{
|
|
||||||
float : left;
|
|
||||||
background : url("tab_r.gif") no-repeat right top;
|
|
||||||
border-bottom : 1px solid #84B0C7;
|
|
||||||
font-size : 8px;
|
|
||||||
font-weight : bold;
|
|
||||||
text-decoration : none;
|
|
||||||
}
|
|
||||||
|
|
||||||
DIV.tabs A:hover
|
|
||||||
{
|
|
||||||
background-position: 100% -150px;
|
|
||||||
}
|
|
||||||
|
|
||||||
DIV.tabs A:link, DIV.tabs A:visited,
|
|
||||||
DIV.tabs A:active, DIV.tabs A:hover
|
|
||||||
{
|
|
||||||
color: #1A419D;
|
|
||||||
}
|
|
||||||
|
|
||||||
DIV.tabs SPAN
|
|
||||||
{
|
|
||||||
float : left;
|
|
||||||
display : block;
|
|
||||||
background : url("tab_l.gif") no-repeat left top;
|
|
||||||
padding : 5px 9px;
|
|
||||||
white-space : nowrap;
|
|
||||||
}
|
|
||||||
|
|
||||||
DIV.tabs INPUT
|
|
||||||
{
|
|
||||||
float : right;
|
|
||||||
display : inline;
|
|
||||||
font-size : 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
DIV.tabs TD
|
|
||||||
{
|
|
||||||
font-size : 8px;
|
|
||||||
font-weight : bold;
|
|
||||||
text-decoration : none;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/* Commented Backslash Hack hides rule from IE5-Mac \*/
|
|
||||||
DIV.tabs SPAN {float : none;}
|
|
||||||
/* End IE5-Mac hack */
|
|
||||||
|
|
||||||
DIV.tabs A:hover SPAN
|
|
||||||
{
|
|
||||||
background-position: 0% -150px;
|
|
||||||
}
|
|
||||||
|
|
||||||
DIV.tabs LI.current A
|
|
||||||
{
|
|
||||||
background-position: 100% -150px;
|
|
||||||
border-width : 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
DIV.tabs LI.current SPAN
|
|
||||||
{
|
|
||||||
background-position: 0% -150px;
|
|
||||||
padding-bottom : 6px;
|
|
||||||
}
|
|
||||||
|
|
||||||
DIV.navpath
|
|
||||||
{
|
|
||||||
background : none;
|
|
||||||
border : none;
|
|
||||||
border-bottom : 1px solid #84B0C7;
|
|
||||||
}
|
|
|
@ -416,7 +416,7 @@ typedef const USBDescriptor * (*usbgetdescriptor_t)(USBDriver *usbp,
|
||||||
* @brief Common ISR code, usb event callback.
|
* @brief Common ISR code, usb event callback.
|
||||||
*
|
*
|
||||||
* @param[in] usbp pointer to the @p USBDriver object
|
* @param[in] usbp pointer to the @p USBDriver object
|
||||||
* @param[in] ep endpoint number
|
* @param[in] evt USB event code
|
||||||
*
|
*
|
||||||
* @notapi
|
* @notapi
|
||||||
*/
|
*/
|
||||||
|
@ -429,7 +429,6 @@ typedef const USBDescriptor * (*usbgetdescriptor_t)(USBDriver *usbp,
|
||||||
* @brief Common ISR code, SOF callback.
|
* @brief Common ISR code, SOF callback.
|
||||||
*
|
*
|
||||||
* @param[in] usbp pointer to the @p USBDriver object
|
* @param[in] usbp pointer to the @p USBDriver object
|
||||||
* @param[in] ep endpoint number
|
|
||||||
*
|
*
|
||||||
* @notapi
|
* @notapi
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -111,7 +111,7 @@ static void serve_interrupt(PWMDriver *pwmp) {
|
||||||
sr = pwmp->tim->SR;
|
sr = pwmp->tim->SR;
|
||||||
sr &= pwmp->tim->DIER;
|
sr &= pwmp->tim->DIER;
|
||||||
pwmp->tim->SR = ~(TIM_SR_CC1IF | TIM_SR_CC2IF | TIM_SR_CC3IF |
|
pwmp->tim->SR = ~(TIM_SR_CC1IF | TIM_SR_CC2IF | TIM_SR_CC3IF |
|
||||||
TIM_SR_CC4IF | TIM_SR_UIF);
|
TIM_SR_CC4IF | TIM_SR_UIF);
|
||||||
if ((sr & TIM_SR_CC1IF) != 0)
|
if ((sr & TIM_SR_CC1IF) != 0)
|
||||||
pwmp->config->channels[0].callback(pwmp);
|
pwmp->config->channels[0].callback(pwmp);
|
||||||
if ((sr & TIM_SR_CC2IF) != 0)
|
if ((sr & TIM_SR_CC2IF) != 0)
|
||||||
|
@ -354,13 +354,13 @@ void pwm_lld_start(PWMDriver *pwmp) {
|
||||||
/* All channels configured in PWM1 mode with preload enabled and will
|
/* All channels configured in PWM1 mode with preload enabled and will
|
||||||
stay that way until the driver is stopped.*/
|
stay that way until the driver is stopped.*/
|
||||||
pwmp->tim->CCMR1 = TIM_CCMR1_OC1M_1 | TIM_CCMR1_OC1M_2 |
|
pwmp->tim->CCMR1 = TIM_CCMR1_OC1M_1 | TIM_CCMR1_OC1M_2 |
|
||||||
TIM_CCMR1_OC1PE |
|
TIM_CCMR1_OC1PE |
|
||||||
TIM_CCMR1_OC2M_1 | TIM_CCMR1_OC2M_2 |
|
TIM_CCMR1_OC2M_1 | TIM_CCMR1_OC2M_2 |
|
||||||
TIM_CCMR1_OC2PE;
|
TIM_CCMR1_OC2PE;
|
||||||
pwmp->tim->CCMR2 = TIM_CCMR2_OC3M_1 | TIM_CCMR2_OC3M_2 |
|
pwmp->tim->CCMR2 = TIM_CCMR2_OC3M_1 | TIM_CCMR2_OC3M_2 |
|
||||||
TIM_CCMR2_OC3PE |
|
TIM_CCMR2_OC3PE |
|
||||||
TIM_CCMR2_OC4M_1 | TIM_CCMR2_OC4M_2 |
|
TIM_CCMR2_OC4M_1 | TIM_CCMR2_OC4M_2 |
|
||||||
TIM_CCMR2_OC4PE;
|
TIM_CCMR2_OC4PE;
|
||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
/* Driver re-configuration scenario, it must be stopped first.*/
|
/* Driver re-configuration scenario, it must be stopped first.*/
|
||||||
|
@ -444,7 +444,7 @@ void pwm_lld_stop(PWMDriver *pwmp) {
|
||||||
pwmp->tim->BDTR = 0;
|
pwmp->tim->BDTR = 0;
|
||||||
pwmp->tim->DIER = 0;
|
pwmp->tim->DIER = 0;
|
||||||
pwmp->tim->SR = 0;
|
pwmp->tim->SR = 0;
|
||||||
pwmp->tim->EGR = TIM_EGR_UG; /* Update event. */
|
pwmp->tim->EGR = TIM_EGR_UG; /* Update event. */
|
||||||
|
|
||||||
#if STM32_PWM_USE_TIM1
|
#if STM32_PWM_USE_TIM1
|
||||||
if (&PWMD1 == pwmp) {
|
if (&PWMD1 == pwmp) {
|
||||||
|
|
|
@ -299,3 +299,5 @@ stall_both:
|
||||||
chSysUnlockFromIsr();
|
chSysUnlockFromIsr();
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** @} */
|
||||||
|
|
|
@ -93,6 +93,11 @@
|
||||||
as default.
|
as default.
|
||||||
- CHANGE: Removed all the prefixes from the structure/union field names
|
- CHANGE: Removed all the prefixes from the structure/union field names
|
||||||
in the HAL subsystem.
|
in the HAL subsystem.
|
||||||
|
- CHANGE: Updated the documentation to use Doxygen 1.7.3 which produces a much
|
||||||
|
more readable output. Also modified the documentation layout to put functions
|
||||||
|
and variables ahead of everything else in the group pages.
|
||||||
|
Doxygen version below 1.7.3 cannot be used anymore because differences in
|
||||||
|
templates.
|
||||||
|
|
||||||
*** 2.3.0 ***
|
*** 2.3.0 ***
|
||||||
- FIX: Fixed race condition in CM0 ports, the fix also improves the
|
- FIX: Fixed race condition in CM0 ports, the fix also improves the
|
||||||
|
|
|
@ -61,7 +61,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
static Semaphore sem1;
|
static Semaphore sem1;
|
||||||
#if CH_USE_MUTEXES
|
#if CH_USE_MUTEXES || defined(__DOXYGEN__)
|
||||||
static Mutex mtx1;
|
static Mutex mtx1;
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
@ -577,7 +577,7 @@ ROMCONST struct testcase testbmk11 = {
|
||||||
bmk11_execute
|
bmk11_execute
|
||||||
};
|
};
|
||||||
|
|
||||||
#if CH_USE_MUTEXES
|
#if CH_USE_MUTEXES || defined(__DOXYGEN__)
|
||||||
/**
|
/**
|
||||||
* @page test_benchmarks_012 Mutexes lock/unlock performance
|
* @page test_benchmarks_012 Mutexes lock/unlock performance
|
||||||
*
|
*
|
||||||
|
@ -648,7 +648,7 @@ static void bmk13_execute(void) {
|
||||||
test_print("--- Semaph: ");
|
test_print("--- Semaph: ");
|
||||||
test_printn(sizeof(Semaphore));
|
test_printn(sizeof(Semaphore));
|
||||||
test_println(" bytes");
|
test_println(" bytes");
|
||||||
#if CH_USE_EVENTS
|
#if CH_USE_EVENTS || defined(__DOXYGEN__)
|
||||||
test_print("--- EventS: ");
|
test_print("--- EventS: ");
|
||||||
test_printn(sizeof(EventSource));
|
test_printn(sizeof(EventSource));
|
||||||
test_println(" bytes");
|
test_println(" bytes");
|
||||||
|
@ -656,22 +656,22 @@ static void bmk13_execute(void) {
|
||||||
test_printn(sizeof(EventListener));
|
test_printn(sizeof(EventListener));
|
||||||
test_println(" bytes");
|
test_println(" bytes");
|
||||||
#endif
|
#endif
|
||||||
#if CH_USE_MUTEXES
|
#if CH_USE_MUTEXES || defined(__DOXYGEN__)
|
||||||
test_print("--- Mutex : ");
|
test_print("--- Mutex : ");
|
||||||
test_printn(sizeof(Mutex));
|
test_printn(sizeof(Mutex));
|
||||||
test_println(" bytes");
|
test_println(" bytes");
|
||||||
#endif
|
#endif
|
||||||
#if CH_USE_CONDVARS
|
#if CH_USE_CONDVARS || defined(__DOXYGEN__)
|
||||||
test_print("--- CondV.: ");
|
test_print("--- CondV.: ");
|
||||||
test_printn(sizeof(CondVar));
|
test_printn(sizeof(CondVar));
|
||||||
test_println(" bytes");
|
test_println(" bytes");
|
||||||
#endif
|
#endif
|
||||||
#if CH_USE_QUEUES
|
#if CH_USE_QUEUES || defined(__DOXYGEN__)
|
||||||
test_print("--- Queue : ");
|
test_print("--- Queue : ");
|
||||||
test_printn(sizeof(GenericQueue));
|
test_printn(sizeof(GenericQueue));
|
||||||
test_println(" bytes");
|
test_println(" bytes");
|
||||||
#endif
|
#endif
|
||||||
#if CH_USE_MAILBOXES
|
#if CH_USE_MAILBOXES || defined(__DOXYGEN__)
|
||||||
test_print("--- MailB.: ");
|
test_print("--- MailB.: ");
|
||||||
test_printn(sizeof(Mailbox));
|
test_printn(sizeof(Mailbox));
|
||||||
test_println(" bytes");
|
test_println(" bytes");
|
||||||
|
@ -701,7 +701,7 @@ ROMCONST struct testcase * ROMCONST patternbmk[] = {
|
||||||
&testbmk9,
|
&testbmk9,
|
||||||
&testbmk10,
|
&testbmk10,
|
||||||
&testbmk11,
|
&testbmk11,
|
||||||
#if CH_USE_MUTEXES
|
#if CH_USE_MUTEXES || defined(__DOXYGEN__)
|
||||||
&testbmk12,
|
&testbmk12,
|
||||||
#endif
|
#endif
|
||||||
&testbmk13,
|
&testbmk13,
|
||||||
|
|
|
@ -53,11 +53,11 @@
|
||||||
* @brief Dynamic thread APIs test header file
|
* @brief Dynamic thread APIs test header file
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#if CH_USE_DYNAMIC
|
#if CH_USE_DYNAMIC || defined(__DOXYGEN__)
|
||||||
#if CH_USE_HEAP
|
#if CH_USE_HEAP || defined(__DOXYGEN__)
|
||||||
static MemoryHeap heap1;
|
static MemoryHeap heap1;
|
||||||
#endif
|
#endif
|
||||||
#if CH_USE_MEMPOOLS
|
#if CH_USE_MEMPOOLS || defined(__DOXYGEN__)
|
||||||
static MemoryPool mp1;
|
static MemoryPool mp1;
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
@ -78,7 +78,7 @@ static msg_t thread(void *p) {
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
#if CH_USE_HEAP
|
#if CH_USE_HEAP || defined(__DOXYGEN__)
|
||||||
static void dyn1_setup(void) {
|
static void dyn1_setup(void) {
|
||||||
|
|
||||||
chHeapInit(&heap1, test.buffer, sizeof(union test_buffers));
|
chHeapInit(&heap1, test.buffer, sizeof(union test_buffers));
|
||||||
|
@ -126,7 +126,7 @@ ROMCONST struct testcase testdyn1 = {
|
||||||
};
|
};
|
||||||
#endif /* CH_USE_HEAP */
|
#endif /* CH_USE_HEAP */
|
||||||
|
|
||||||
#if CH_USE_MEMPOOLS
|
#if CH_USE_MEMPOOLS || defined(__DOXYGEN__)
|
||||||
/**
|
/**
|
||||||
* @page test_dynamic_002 Threads creation from Memory Pool
|
* @page test_dynamic_002 Threads creation from Memory Pool
|
||||||
*
|
*
|
||||||
|
@ -182,7 +182,7 @@ ROMCONST struct testcase testdyn2 = {
|
||||||
};
|
};
|
||||||
#endif /* CH_USE_MEMPOOLS */
|
#endif /* CH_USE_MEMPOOLS */
|
||||||
|
|
||||||
#if CH_USE_HEAP && CH_USE_REGISTRY
|
#if (CH_USE_HEAP && CH_USE_REGISTRY) || defined(__DOXYGEN__)
|
||||||
/**
|
/**
|
||||||
* @page test_dynamic_003 Registry and References test
|
* @page test_dynamic_003 Registry and References test
|
||||||
*
|
*
|
||||||
|
@ -251,14 +251,14 @@ ROMCONST struct testcase testdyn3 = {
|
||||||
* @brief Test sequence for dynamic APIs.
|
* @brief Test sequence for dynamic APIs.
|
||||||
*/
|
*/
|
||||||
ROMCONST struct testcase * ROMCONST patterndyn[] = {
|
ROMCONST struct testcase * ROMCONST patterndyn[] = {
|
||||||
#if CH_USE_DYNAMIC
|
#if CH_USE_DYNAMIC || defined(__DOXYGEN__)
|
||||||
#if CH_USE_HEAP
|
#if CH_USE_HEAP || defined(__DOXYGEN__)
|
||||||
&testdyn1,
|
&testdyn1,
|
||||||
#endif
|
#endif
|
||||||
#if CH_USE_MEMPOOLS
|
#if CH_USE_MEMPOOLS || defined(__DOXYGEN__)
|
||||||
&testdyn2,
|
&testdyn2,
|
||||||
#endif
|
#endif
|
||||||
#if CH_USE_HEAP && CH_USE_REGISTRY
|
#if (CH_USE_HEAP && CH_USE_REGISTRY) || defined(__DOXYGEN__)
|
||||||
&testdyn3,
|
&testdyn3,
|
||||||
#endif
|
#endif
|
||||||
#endif
|
#endif
|
||||||
|
|
|
@ -51,7 +51,7 @@
|
||||||
* @brief Events test header file
|
* @brief Events test header file
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#if CH_USE_EVENTS
|
#if CH_USE_EVENTS || defined(__DOXYGEN__)
|
||||||
|
|
||||||
#define ALLOWED_DELAY MS2ST(5)
|
#define ALLOWED_DELAY MS2ST(5)
|
||||||
|
|
||||||
|
@ -232,7 +232,7 @@ ROMCONST struct testcase testevt2 = {
|
||||||
evt2_execute
|
evt2_execute
|
||||||
};
|
};
|
||||||
|
|
||||||
#if CH_USE_EVENTS_TIMEOUT
|
#if CH_USE_EVENTS_TIMEOUT || defined(__DOXYGEN__)
|
||||||
/**
|
/**
|
||||||
* @page test_events_003 Events timeout
|
* @page test_events_003 Events timeout
|
||||||
*
|
*
|
||||||
|
@ -285,10 +285,10 @@ ROMCONST struct testcase testevt3 = {
|
||||||
* @brief Test sequence for events.
|
* @brief Test sequence for events.
|
||||||
*/
|
*/
|
||||||
ROMCONST struct testcase * ROMCONST patternevt[] = {
|
ROMCONST struct testcase * ROMCONST patternevt[] = {
|
||||||
#if CH_USE_EVENTS
|
#if CH_USE_EVENTS || defined(__DOXYGEN__)
|
||||||
&testevt1,
|
&testevt1,
|
||||||
&testevt2,
|
&testevt2,
|
||||||
#if CH_USE_EVENTS_TIMEOUT
|
#if CH_USE_EVENTS_TIMEOUT || defined(__DOXYGEN__)
|
||||||
&testevt3,
|
&testevt3,
|
||||||
#endif
|
#endif
|
||||||
#endif
|
#endif
|
||||||
|
|
|
@ -48,7 +48,7 @@
|
||||||
* @brief Heap header file
|
* @brief Heap header file
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#if CH_USE_HEAP
|
#if CH_USE_HEAP || defined(__DOXYGEN__)
|
||||||
|
|
||||||
#define SIZE 16
|
#define SIZE 16
|
||||||
|
|
||||||
|
@ -156,7 +156,7 @@ ROMCONST struct testcase testheap1 = {
|
||||||
* @brief Test sequence for heap.
|
* @brief Test sequence for heap.
|
||||||
*/
|
*/
|
||||||
ROMCONST struct testcase * ROMCONST patternheap[] = {
|
ROMCONST struct testcase * ROMCONST patternheap[] = {
|
||||||
#if CH_USE_HEAP
|
#if CH_USE_HEAP || defined(__DOXYGEN__)
|
||||||
&testheap1,
|
&testheap1,
|
||||||
#endif
|
#endif
|
||||||
NULL
|
NULL
|
||||||
|
|
|
@ -51,7 +51,7 @@
|
||||||
* @brief Mailboxes header file
|
* @brief Mailboxes header file
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#if CH_USE_MAILBOXES
|
#if CH_USE_MAILBOXES || defined(__DOXYGEN__)
|
||||||
|
|
||||||
#define ALLOWED_DELAY MS2ST(5)
|
#define ALLOWED_DELAY MS2ST(5)
|
||||||
#define MB_SIZE 5
|
#define MB_SIZE 5
|
||||||
|
@ -218,7 +218,7 @@ ROMCONST struct testcase testmbox1 = {
|
||||||
* @brief Test sequence for mailboxes.
|
* @brief Test sequence for mailboxes.
|
||||||
*/
|
*/
|
||||||
ROMCONST struct testcase * ROMCONST patternmbox[] = {
|
ROMCONST struct testcase * ROMCONST patternmbox[] = {
|
||||||
#if CH_USE_MAILBOXES
|
#if CH_USE_MAILBOXES || defined(__DOXYGEN__)
|
||||||
&testmbox1,
|
&testmbox1,
|
||||||
#endif
|
#endif
|
||||||
NULL
|
NULL
|
||||||
|
|
|
@ -49,7 +49,7 @@
|
||||||
* @brief Messages header file
|
* @brief Messages header file
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#if CH_USE_MESSAGES
|
#if CH_USE_MESSAGES || defined(__DOXYGEN__)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @page test_msg_001 Messages Server loop
|
* @page test_msg_001 Messages Server loop
|
||||||
|
@ -105,7 +105,7 @@ ROMCONST struct testcase testmsg1 = {
|
||||||
* @brief Test sequence for messages.
|
* @brief Test sequence for messages.
|
||||||
*/
|
*/
|
||||||
ROMCONST struct testcase * ROMCONST patternmsg[] = {
|
ROMCONST struct testcase * ROMCONST patternmsg[] = {
|
||||||
#if CH_USE_MESSAGES
|
#if CH_USE_MESSAGES || defined(__DOXYGEN__)
|
||||||
&testmsg1,
|
&testmsg1,
|
||||||
#endif
|
#endif
|
||||||
NULL
|
NULL
|
||||||
|
|
|
@ -60,7 +60,7 @@
|
||||||
* @brief Mutexes and CondVars test header file
|
* @brief Mutexes and CondVars test header file
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#if CH_USE_MUTEXES
|
#if CH_USE_MUTEXES || defined(__DOXYGEN__)
|
||||||
|
|
||||||
#define ALLOWED_DELAY 5
|
#define ALLOWED_DELAY 5
|
||||||
|
|
||||||
|
@ -71,7 +71,7 @@
|
||||||
*/
|
*/
|
||||||
static MUTEX_DECL(m1);
|
static MUTEX_DECL(m1);
|
||||||
static MUTEX_DECL(m2);
|
static MUTEX_DECL(m2);
|
||||||
#if CH_USE_CONDVARS
|
#if CH_USE_CONDVARS || defined(__DOXYGEN__)
|
||||||
static CONDVAR_DECL(c1);
|
static CONDVAR_DECL(c1);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
@ -120,7 +120,7 @@ ROMCONST struct testcase testmtx1 = {
|
||||||
mtx1_execute
|
mtx1_execute
|
||||||
};
|
};
|
||||||
|
|
||||||
#if CH_DBG_THREADS_PROFILING
|
#if CH_DBG_THREADS_PROFILING || defined(__DOXYGEN__)
|
||||||
/**
|
/**
|
||||||
* @page test_mtx_002 Priority inheritance, simple case
|
* @page test_mtx_002 Priority inheritance, simple case
|
||||||
*
|
*
|
||||||
|
@ -467,7 +467,7 @@ ROMCONST struct testcase testmtx5 = {
|
||||||
mtx5_execute
|
mtx5_execute
|
||||||
};
|
};
|
||||||
|
|
||||||
#if CH_USE_CONDVARS
|
#if CH_USE_CONDVARS || defined(__DOXYGEN__)
|
||||||
/**
|
/**
|
||||||
* @page test_mtx_006 Condition Variable signal test
|
* @page test_mtx_006 Condition Variable signal test
|
||||||
*
|
*
|
||||||
|
@ -578,7 +578,7 @@ static msg_t thread11(void *p) {
|
||||||
|
|
||||||
chMtxLock(&m2);
|
chMtxLock(&m2);
|
||||||
chMtxLock(&m1);
|
chMtxLock(&m1);
|
||||||
#if CH_USE_CONDVARS_TIMEOUT
|
#if CH_USE_CONDVARS_TIMEOUT || defined(__DOXYGEN__)
|
||||||
chCondWaitTimeout(&c1, TIME_INFINITE);
|
chCondWaitTimeout(&c1, TIME_INFINITE);
|
||||||
#else
|
#else
|
||||||
chCondWait(&c1);
|
chCondWait(&c1);
|
||||||
|
@ -622,15 +622,15 @@ ROMCONST struct testcase testmtx8 = {
|
||||||
* @brief Test sequence for mutexes.
|
* @brief Test sequence for mutexes.
|
||||||
*/
|
*/
|
||||||
ROMCONST struct testcase * ROMCONST patternmtx[] = {
|
ROMCONST struct testcase * ROMCONST patternmtx[] = {
|
||||||
#if CH_USE_MUTEXES
|
#if CH_USE_MUTEXES || defined(__DOXYGEN__)
|
||||||
&testmtx1,
|
&testmtx1,
|
||||||
#if CH_DBG_THREADS_PROFILING
|
#if CH_DBG_THREADS_PROFILING || defined(__DOXYGEN__)
|
||||||
&testmtx2,
|
&testmtx2,
|
||||||
&testmtx3,
|
&testmtx3,
|
||||||
#endif
|
#endif
|
||||||
&testmtx4,
|
&testmtx4,
|
||||||
&testmtx5,
|
&testmtx5,
|
||||||
#if CH_USE_CONDVARS
|
#if CH_USE_CONDVARS || defined(__DOXYGEN__)
|
||||||
&testmtx6,
|
&testmtx6,
|
||||||
&testmtx7,
|
&testmtx7,
|
||||||
&testmtx8,
|
&testmtx8,
|
||||||
|
|
|
@ -48,7 +48,7 @@
|
||||||
* @brief Memory Pools test header file
|
* @brief Memory Pools test header file
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#if CH_USE_MEMPOOLS
|
#if CH_USE_MEMPOOLS || defined(__DOXYGEN__)
|
||||||
|
|
||||||
static MEMORYPOOL_DECL(mp1, THD_WA_SIZE(THREADS_STACK_SIZE), NULL);
|
static MEMORYPOOL_DECL(mp1, THD_WA_SIZE(THREADS_STACK_SIZE), NULL);
|
||||||
|
|
||||||
|
@ -104,7 +104,7 @@ ROMCONST struct testcase testpools1 = {
|
||||||
* @brief Test sequence for pools.
|
* @brief Test sequence for pools.
|
||||||
*/
|
*/
|
||||||
ROMCONST struct testcase * ROMCONST patternpools[] = {
|
ROMCONST struct testcase * ROMCONST patternpools[] = {
|
||||||
#if CH_USE_MEMPOOLS
|
#if CH_USE_MEMPOOLS || defined(__DOXYGEN__)
|
||||||
&testpools1,
|
&testpools1,
|
||||||
#endif
|
#endif
|
||||||
NULL
|
NULL
|
||||||
|
|
|
@ -54,7 +54,7 @@
|
||||||
* @brief I/O Queues test header file
|
* @brief I/O Queues test header file
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#if CH_USE_QUEUES
|
#if CH_USE_QUEUES || defined(__DOXYGEN__)
|
||||||
|
|
||||||
#define TEST_QUEUES_SIZE 4
|
#define TEST_QUEUES_SIZE 4
|
||||||
|
|
||||||
|
@ -224,7 +224,7 @@ ROMCONST struct testcase testqueues2 = {
|
||||||
* @brief Test sequence for queues.
|
* @brief Test sequence for queues.
|
||||||
*/
|
*/
|
||||||
ROMCONST struct testcase * ROMCONST patternqueues[] = {
|
ROMCONST struct testcase * ROMCONST patternqueues[] = {
|
||||||
#if CH_USE_QUEUES
|
#if CH_USE_QUEUES || defined(__DOXYGEN__)
|
||||||
&testqueues1,
|
&testqueues1,
|
||||||
&testqueues2,
|
&testqueues2,
|
||||||
#endif
|
#endif
|
||||||
|
|
|
@ -51,7 +51,7 @@
|
||||||
* @brief Semaphores test header file
|
* @brief Semaphores test header file
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#if CH_USE_SEMAPHORES
|
#if CH_USE_SEMAPHORES || defined(__DOXYGEN__)
|
||||||
|
|
||||||
#define ALLOWED_DELAY MS2ST(5)
|
#define ALLOWED_DELAY MS2ST(5)
|
||||||
|
|
||||||
|
@ -190,7 +190,7 @@ ROMCONST struct testcase testsem2 = {
|
||||||
sem2_execute
|
sem2_execute
|
||||||
};
|
};
|
||||||
|
|
||||||
#if CH_USE_SEMSW
|
#if CH_USE_SEMSW || defined(__DOXYGEN__)
|
||||||
/**
|
/**
|
||||||
* @page test_sem_003 Atomic signal-wait test
|
* @page test_sem_003 Atomic signal-wait test
|
||||||
*
|
*
|
||||||
|
@ -292,10 +292,10 @@ ROMCONST struct testcase testsem4 = {
|
||||||
* @brief Test sequence for semaphores.
|
* @brief Test sequence for semaphores.
|
||||||
*/
|
*/
|
||||||
ROMCONST struct testcase * ROMCONST patternsem[] = {
|
ROMCONST struct testcase * ROMCONST patternsem[] = {
|
||||||
#if CH_USE_SEMAPHORES
|
#if CH_USE_SEMAPHORES || defined(__DOXYGEN__)
|
||||||
&testsem1,
|
&testsem1,
|
||||||
&testsem2,
|
&testsem2,
|
||||||
#if CH_USE_SEMSW
|
#if CH_USE_SEMSW || defined(__DOXYGEN__)
|
||||||
&testsem3,
|
&testsem3,
|
||||||
#endif
|
#endif
|
||||||
&testsem4,
|
&testsem4,
|
||||||
|
|
|
@ -142,7 +142,7 @@ static void thd3_execute(void) {
|
||||||
test_assert(4, chThdGetPriority() == prio,
|
test_assert(4, chThdGetPriority() == prio,
|
||||||
"unexpected priority level");
|
"unexpected priority level");
|
||||||
|
|
||||||
#if CH_USE_MUTEXES
|
#if CH_USE_MUTEXES || defined(__DOXYGEN__)
|
||||||
/* Simulates a priority boost situation (p_prio > p_realprio).*/
|
/* Simulates a priority boost situation (p_prio > p_realprio).*/
|
||||||
chSysLock();
|
chSysLock();
|
||||||
chThdSelf()->p_prio += 2;
|
chThdSelf()->p_prio += 2;
|
||||||
|
|
Loading…
Reference in New Issue