URL
https://opencores.org/ocsvn/opencpu32/opencpu32/trunk
Subversion Repositories opencpu32
Compare Revisions
- This comparison shows the changes necessary to convert path
/opencpu32/trunk
- from Rev 11 to Rev 12
- ↔ Reverse comparison
Rev 11 → Rev 12
/hdl/opencpu32/_xmsgs/pn_parser.xmsgs
1,15 → 1,15
<?xml version="1.0" encoding="UTF-8"?> |
<!-- IMPORTANT: This is an internal file that has been generated --> |
<!-- by the Xilinx ISE software. Any direct editing or --> |
<!-- changes made to this file may result in unpredictable --> |
<!-- behavior or data corruption. It is strongly advised that --> |
<!-- users do not edit the contents of this file. --> |
<!-- --> |
<!-- Copyright (c) 1995-2011 Xilinx, Inc. All rights reserved. --> |
|
<messages> |
<msg type="info" file="ProjectMgmt" num="1061" ><arg fmt="%s" index="1">Parsing VHDL file "E:/opencpu32/hdl/opencpu32/testMultiplexer2_1.vhd" into library work</arg> |
</msg> |
|
</messages> |
|
<?xml version="1.0" encoding="UTF-8"?> |
<!-- IMPORTANT: This is an internal file that has been generated --> |
<!-- by the Xilinx ISE software. Any direct editing or --> |
<!-- changes made to this file may result in unpredictable --> |
<!-- behavior or data corruption. It is strongly advised that --> |
<!-- users do not edit the contents of this file. --> |
<!-- --> |
<!-- Copyright (c) 1995-2011 Xilinx, Inc. All rights reserved. --> |
|
<messages> |
<msg type="info" file="ProjectMgmt" num="1061" ><arg fmt="%s" index="1">Parsing VHDL file "/home/laraujo/work/opencpu32/hdl/opencpu32/testAlu.vhd" into library work</arg> |
</msg> |
|
</messages> |
|
/hdl/opencpu32/testAlu.vhd
30,16 → 30,16
|
|
--Inputs |
signal A : std_logic_vector((nBits - 1) downto 0) := (others => '0'); |
signal B : std_logic_vector((nBits - 1) downto 0) := (others => '0'); |
signal sel : aluOps := alu_sum; |
signal A : std_logic_vector((nBits - 1) downto 0) := (others => '0'); --! Wire to connect Test signal to component |
signal B : std_logic_vector((nBits - 1) downto 0) := (others => '0'); --! Wire to connect Test signal to component |
signal sel : aluOps := alu_sum; --! Wire to connect Test signal to component |
|
--Outputs |
signal S : std_logic_vector((nBits - 1) downto 0); |
signal S : std_logic_vector((nBits - 1) downto 0); --! Wire to connect Test signal to component |
|
BEGIN |
|
-- Instantiate the Unit Under Test (UUT) |
--! Instantiate the Unit Under Test (Alu) (Doxygen bug if it's not commented!) |
uut: Alu PORT MAP ( |
A => A, |
B => B, |
/hdl/opencpu32/testMultiplexer2_1.vhd
29,16 → 29,16
|
|
--Inputs |
signal A : std_logic_vector((nBits - 1) downto 0) := (others => '0'); |
signal B : std_logic_vector((nBits - 1) downto 0) := (others => '0'); |
signal sel : std_logic := '0'; |
signal A : std_logic_vector((nBits - 1) downto 0) := (others => '0'); --! Wire to connect Test signal to component |
signal B : std_logic_vector((nBits - 1) downto 0) := (others => '0'); --! Wire to connect Test signal to component |
signal sel : std_logic := '0'; --! Wire to connect Test signal to component |
|
--Outputs |
signal S : std_logic_vector((nBits - 1) downto 0); |
signal S : std_logic_vector((nBits - 1) downto 0); --! Wire to connect Test signal to component |
|
BEGIN |
|
-- Instantiate the Unit Under Test (UUT) |
--!Instantiate the Unit Under Test (Multiplexer2_1) (Doxygen bug if it's not commented!) |
uut: Multiplexer2_1 PORT MAP ( |
A => A, |
B => B, |
/docs/confDoxygen.cnf
1,4 → 1,4
# Doxyfile 1.8.0 |
# Doxyfile 1.6.3 |
|
# This file describes the settings to be used by the documentation system |
# doxygen (www.doxygen.org) for a project |
22,9 → 22,8
|
DOXYFILE_ENCODING = UTF-8 |
|
# The PROJECT_NAME tag is a single word (or sequence of words) that should |
# identify the project. Note that if you do not use Doxywizard you need |
# to put quotes around the project name if it contains spaces. |
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
# by quotes) that should identify the project. |
|
PROJECT_NAME = "OpenCPU32 Documentation" |
|
34,25 → 33,12
|
PROJECT_NUMBER = |
|
# 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) |
# base path where the generated documentation will be put. |
# If a relative path is entered, it will be relative to the location |
# where doxygen was started. If left blank the current directory will be used. |
|
OUTPUT_DIRECTORY = E:/opencpu32/docs/gen |
OUTPUT_DIRECTORY = gen |
|
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
# 4096 sub-directories (in 2 levels) under the output directory of each output |
71,7 → 57,7
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, |
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English |
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, |
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, |
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, |
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. |
|
OUTPUT_LANGUAGE = English |
150,7 → 136,7
STRIP_FROM_INC_PATH = |
|
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
# (but less readable) file names. This can be useful if your file system |
# (but less readable) file names. This can be useful is your file systems |
# doesn't support long names like on DOS, Mac, or CD-ROM. |
|
SHORT_NAMES = NO |
205,13 → 191,6
|
ALIASES = |
|
# This tag can be used to specify a number of word-keyword mappings (TCL only). |
# A mapping has the form "name=value". For example adding |
# "class=itcl::class" will allow you to use the command class in the |
# itcl::class meaning. |
|
TCL_SUBST = |
|
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C |
# sources only. Doxygen will then generate output that is more tailored for C. |
# For instance, some of the names that are used will be different. The list |
238,32 → 217,23
|
OPTIMIZE_OUTPUT_VHDL = YES |
|
# Doxygen selects the parser to use depending on the extension of the files it |
# 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. The format is ext=language, where ext is a file extension, and language |
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, |
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make |
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C |
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions |
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. |
# Doxygen selects the parser to use depending on the extension of the files it 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. |
# The format is ext=language, where ext is a file extension, and language is one of |
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, |
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat |
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), |
# use: inc=Fortran f=C. Note that for custom extensions you also need to set |
# FILE_PATTERNS otherwise the files are not read by doxygen. |
|
EXTENSION_MAPPING = |
|
# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all |
# comments according to the Markdown format, which allows for more readable |
# documentation. See http://daringfireball.net/projects/markdown/ for details. |
# The output of markdown processing is further processed by doxygen, so you |
# can mix doxygen, HTML, and XML commands with Markdown formatting. |
# Disable only in case of backward compatibilities issues. |
|
MARKDOWN_SUPPORT = YES |
|
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want |
# 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 |
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. |
# func(std::string) {}). This also makes the inheritance and collaboration |
# func(std::string) {}). This also make the inheritance and collaboration |
# diagrams that involve STL classes more complete and accurate. |
|
BUILTIN_STL_SUPPORT = NO |
281,7 → 251,7
|
# 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) |
# will make doxygen replace the get and set methods by a property in the |
# will make doxygen to replace the get and set methods by a property in the |
# 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 |
# methods anyway, you should set this option to NO. |
303,22 → 273,6
|
SUBGROUPING = YES |
|
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and |
# unions are shown inside the group in which they are included (e.g. using |
# @ingroup) instead of on a separate page (for HTML and Man pages) or |
# section (for LaTeX and RTF). |
|
INLINE_GROUPED_CLASSES = NO |
|
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and |
# unions with only public data fields will be shown inline in the documentation |
# of the scope in which they are defined (i.e. file, namespace, or group |
# documentation), provided this scope is documented. If set to NO (the default), |
# structs, classes, and unions are shown on a separate page (for HTML and Man |
# pages) or section (for LaTeX and RTF). |
|
INLINE_SIMPLE_STRUCTS = NO |
|
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum |
# is documented as struct, union, or enum with the name of the typedef. So |
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct |
335,27 → 289,16
# 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 |
# doxygen to be busy swapping symbols to and from disk most of the time |
# causing a significant performance penalty. |
# causing a significant performance penality. |
# 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 |
# a logarithmic scale so increasing the size by one will roughly double the |
# a logarithmic scale so increasing the size by one will rougly double the |
# 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, |
# corresponding to a cache size of 2^16 = 65536 symbols. |
# corresponding to a cache size of 2^16 = 65536 symbols |
|
SYMBOL_CACHE_SIZE = 0 |
|
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be |
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given |
# their name and scope. Since this can be an expensive process and often the |
# same symbol appear multiple times in the code, doxygen keeps a cache of |
# pre-resolved symbols. If the cache is too small doxygen will become slower. |
# If the cache is too large, memory is wasted. The cache size is given by this |
# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, |
# corresponding to a cache size of 2^16 = 65536 symbols. |
|
LOOKUP_CACHE_SIZE = 0 |
|
#--------------------------------------------------------------------------- |
# Build related configuration options |
#--------------------------------------------------------------------------- |
372,11 → 315,6
|
EXTRACT_PRIVATE = NO |
|
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal |
# scope will be included in the documentation. |
|
EXTRACT_PACKAGE = NO |
|
# If the EXTRACT_STATIC tag is set to YES all static members of a file |
# will be included in the documentation. |
|
399,7 → 337,7
# extracted and appear in the documentation as a namespace called |
# 'anonymous_namespace{file}', where file will be replaced with the base |
# name of the file that contains the anonymous namespace. By default |
# anonymous namespaces are hidden. |
# anonymous namespace are hidden. |
|
EXTRACT_ANON_NSPACES = NO |
|
484,12 → 422,12
|
SORT_BRIEF_DOCS = NO |
|
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen |
# will sort the (brief and detailed) documentation of class members so that |
# constructors and destructors are listed first. If set to NO (the default) |
# the constructors will appear in the respective orders defined by |
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. |
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO |
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen |
# will sort the (brief and detailed) documentation of class members so that |
# constructors and destructors are listed first. If set to NO (the default) |
# the constructors will appear in the respective orders defined by |
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. |
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO |
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. |
|
SORT_MEMBERS_CTORS_1ST = NO |
510,15 → 448,6
|
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 |
# disable (NO) the todo list. This list is created by putting \todo |
# commands in the documentation. |
549,10 → 478,10
ENABLED_SECTIONS = |
|
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
# the initial value of a variable or macro consists of for it to appear in |
# the initial value of a variable or define consists of for it to appear in |
# 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. |
# The appearance of the initializer of individual variables and macros in the |
# The appearance of the initializer of individual variables and defines in the |
# documentation can be controlled using \showinitializer or \hideinitializer |
# command in the documentation regardless of this setting. |
|
592,25 → 521,15
|
FILE_VERSION_FILTER = |
|
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed |
# by doxygen. The layout file controls the global structure of the generated |
# output files in an output format independent way. The create the layout file |
# that represents doxygen's defaults, run doxygen with the -l option. |
# You can optionally specify a file name after the option, if omitted |
# DoxygenLayout.xml will be used as the name of the layout file. |
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by |
# doxygen. The layout file controls the global structure of the generated output files |
# in an output format independent way. The create the layout file that represents |
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a |
# file name after the option, if omitted DoxygenLayout.xml will be used as the name |
# of the layout file. |
|
LAYOUT_FILE = |
|
# The CITE_BIB_FILES tag can be used to specify one or more bib files |
# containing the references data. This must be a list of .bib files. The |
# .bib extension is automatically appended if omitted. Using this command |
# requires the bibtex tool to be installed. See also |
# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style |
# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this |
# feature you need bibtex and perl available in the search path. |
|
CITE_BIB_FILES = |
|
#--------------------------------------------------------------------------- |
# configuration options related to warning and progress messages |
#--------------------------------------------------------------------------- |
639,7 → 558,7
|
WARN_IF_DOC_ERROR = YES |
|
# The WARN_NO_PARAMDOC option can be enabled to get warnings for |
# This WARN_NO_PARAMDOC option can be abled to get warnings for |
# 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 |
# wrong or incomplete parameter documentation, but not about the absence of |
671,7 → 590,7
# directories like "/usr/src/myproject". Separate the files or directories |
# with spaces. |
|
INPUT = E:/opencpu32/hdl/opencpu32 |
INPUT = ../hdl |
|
# This tag can be used to specify the character encoding of the source files |
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is |
685,9 → 604,8
# 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 |
# blank the following patterns are tested: |
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh |
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py |
# *.f90 *.f *.for *.vhd *.vhdl |
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx |
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 |
|
FILE_PATTERNS = *.vhd \ |
*.vhdl |
698,16 → 616,14
|
RECURSIVE = YES |
|
# The EXCLUDE tag can be used to specify files and/or directories that should be |
# The EXCLUDE tag can be used to specify files and/or directories that should |
# excluded from the INPUT source files. This way you can easily exclude a |
# subdirectory from a directory tree whose root is specified with the INPUT tag. |
# Note that relative paths are relative to the directory from which doxygen is |
# run. |
# subdirectory from a directory tree whose root is specified with the INPUT tag. |
|
EXCLUDE = |
|
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or |
# directories that are symbolic links (a Unix file system feature) are excluded |
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or |
# directories that are symbolic links (a Unix filesystem feature) are excluded |
# from the input. |
|
EXCLUDE_SYMLINKS = NO |
768,8 → 684,8
# basis. 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 |
# info on how filters are used. If FILTER_PATTERNS is empty or if |
# non of the patterns match the file name, INPUT_FILTER is applied. |
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER |
# is applied to all files. |
|
FILTER_PATTERNS = |
|
779,14 → 695,6
|
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 |
#--------------------------------------------------------------------------- |
888,14 → 796,7
|
# The HTML_HEADER tag can be used to specify a personal HTML header for |
# each generated HTML page. If it is left blank doxygen will generate a |
# standard header. Note that when using a custom header you are responsible |
# for the proper inclusion of any scripts and style sheets that doxygen |
# needs, which is dependent on the configuration options used. |
# It is advised to generate a default header using "doxygen -w html |
# header.html footer.html stylesheet.css YourConfigFile" and then modify |
# that header. Note that the header is subject to change so you typically |
# have to redo this when upgrading to a newer version of doxygen or when |
# changing the value of configuration settings such as GENERATE_TREEVIEW! |
# standard header. |
|
HTML_HEADER = |
|
910,44 → 811,10
# fine-tune the look of the HTML output. If the tag is left blank doxygen |
# will generate a default style sheet. Note that doxygen will try to copy |
# the style sheet file to the HTML output directory, so don't put your own |
# style sheet 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 = |
|
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or |
# other source files which should be copied to the HTML output directory. Note |
# that these files will be copied to the base HTML output directory. Use the |
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these |
# files. In the HTML_STYLESHEET file, use the file name only. Also note that |
# the files will be copied as-is; there are no commands or markers available. |
|
HTML_EXTRA_FILES = |
|
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. |
# Doxygen will adjust the colors in the style sheet 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 |
# page will contain the date and time when the page was generated. Setting |
# this to NO can help when comparing the output of multiple runs. |
976,8 → 843,7
# directory and running "make install" will install the docset in |
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find |
# 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 |
|
995,16 → 861,6
|
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 |
# 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) |
1049,10 → 905,10
|
TOC_EXPAND = NO |
|
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and |
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated |
# that can be used as input for Qt's qhelpgenerator to generate a |
# Qt Compressed Help (.qch) of the generated HTML documentation. |
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER |
# are set, an additional index file will be generated that can be used as input for |
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated |
# HTML documentation. |
|
GENERATE_QHP = NO |
|
1074,24 → 930,20
|
QHP_VIRTUAL_FOLDER = doc |
|
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to |
# add. For more information please see |
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. |
# For more information please see |
# http://doc.trolltech.com/qthelpproject.html#custom-filters |
|
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 |
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> |
# Qt Help Project / Custom Filters</a>. |
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 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 = |
|
# 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. |
# <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 = |
|
1103,12 → 955,12
QHG_LOCATION = |
|
# 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 |
# 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 |
# the directory within the plugins directory should be the same as |
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before |
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before |
# the help appears. |
|
GENERATE_ECLIPSEHELP = NO |
1119,14 → 971,17
|
ECLIPSE_DOC_ID = org.doxygen.Project |
|
# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) |
# at top of each HTML page. The value NO (the default) enables the index and |
# the value YES disables it. Since the tabs have the same information as the |
# navigation tree you can set this option to NO if you already set |
# GENERATE_TREEVIEW to YES. |
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
# top of each HTML page. The value NO (the default) enables the index and |
# the value YES disables it. |
|
DISABLE_INDEX = NO |
|
# This tag can be used to set the number of enum values (range [1..20]) |
# that doxygen will group on one line in the generated HTML documentation. |
|
ENUM_VALUES_PER_LINE = 4 |
|
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
# structure should be generated to display hierarchical information. |
# If the tag value is set to YES, a side panel will be generated |
1133,19 → 988,10
# containing a tree-like index structure (just like the one that |
# is generated for HTML Help). For this to work a browser that supports |
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). |
# Windows users are probably better off using the HTML help feature. |
# Since the tree basically has the same information as the tab index you |
# could consider to set DISABLE_INDEX to NO when enabling this option. |
# Windows users are probably better off using the HTML help feature. |
|
GENERATE_TREEVIEW = NO |
GENERATE_TREEVIEW = YES |
|
# The ENUM_VALUES_PER_LINE 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. Note that a value of 0 will completely suppress the enum |
# values from appearing in the overview section. |
|
ENUM_VALUES_PER_LINE = 4 |
|
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, |
# and Class Hierarchy pages using a tree view instead of an ordered list. |
|
1157,11 → 1003,6
|
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 |
# 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 |
1170,43 → 1011,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 may 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 Content Delivery Network so you can quickly see the result without |
# installing MathJax. However, it is strongly recommended to install a local |
# copy of MathJax from http://www.mathjax.org before deployment. |
|
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest |
|
# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension |
# names that should be enabled during MathJax rendering. |
|
MATHJAX_EXTENSIONS = |
|
# 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 |
# and DHTML and should work on any modern browser. Note that when using |
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets |
# and DHTML and should work on any modern browser. Note that when using |
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets |
# (GENERATE_DOCSET) there is already a search function so this one should |
# typically be disabled. For large projects the javascript based search engine |
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. |
1213,12 → 1021,12
|
SEARCHENGINE = YES |
|
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be |
# implemented using a PHP enabled web server instead of at the web client |
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be |
# implemented using a PHP enabled web server instead of at the web client |
# using Javascript. Doxygen will generate the search PHP script and index |
# file to put on the web server. The advantage of the server |
# based approach is that it scales better to large projects and allows |
# full text search. The disadvantages are that it is more difficult to setup |
# file to put on the web server. The advantage of the server |
# 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 |
# and does not have live searching capabilities. |
|
SERVER_BASED_SEARCH = NO |
1259,7 → 1067,7
COMPACT_LATEX = NO |
|
# The PAPER_TYPE tag can be used to set the paper type that is used |
# by the printer. Possible values are: a4, letter, legal and |
# by the printer. Possible values are: a4, a4wide, letter, legal and |
# executive. If left blank a4wide will be used. |
|
PAPER_TYPE = a4 |
1276,19 → 1084,12
|
LATEX_HEADER = |
|
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for |
# the generated latex document. The footer should contain everything after |
# the last chapter. If it is left blank doxygen will generate a |
# standard footer. Notice: only use this tag if you know what you are doing! |
|
LATEX_FOOTER = |
|
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
# is prepared for conversion to pdf (using ps2pdf). The pdf file will |
# contain links (just like the HTML output) instead of page references |
# This makes the output suitable for online browsing using a pdf viewer. |
|
PDF_HYPERLINKS = YES |
PDF_HYPERLINKS = NO |
|
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
# plain latex in the generated Makefile. Set this option to YES to get a |
1309,19 → 1110,13
|
LATEX_HIDE_INDICES = NO |
|
# If LATEX_SOURCE_CODE is set to YES then doxygen will include |
# source code with syntax highlighting in the LaTeX output. |
# Note that which sources are shown also depends on other settings |
# If LATEX_SOURCE_CODE is set to YES then doxygen will include |
# source code with syntax highlighting in the LaTeX output. |
# Note that which sources are shown also depends on other settings |
# such as SOURCE_BROWSER. |
|
LATEX_SOURCE_CODE = NO |
|
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the |
# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See |
# http://en.wikipedia.org/wiki/BibTeX for more info. |
|
LATEX_BIB_STYLE = plain |
|
#--------------------------------------------------------------------------- |
# configuration options related to the RTF output |
#--------------------------------------------------------------------------- |
1353,7 → 1148,7
|
RTF_HYPERLINKS = NO |
|
# Load style sheet definitions from file. Syntax is similar to doxygen's |
# Load stylesheet definitions from file. Syntax is similar to doxygen's |
# config file, i.e. a series of assignments. You only have to provide |
# replacements, missing definitions are set to their default value. |
|
1496,7 → 1291,7
EXPAND_ONLY_PREDEF = NO |
|
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
# pointed to by INCLUDE_PATH will be searched when a #include is found. |
# in the INCLUDE_PATH (see below) will be search if a #include is found. |
|
SEARCH_INCLUDES = YES |
|
1526,15 → 1321,15
# 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. |
# 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 that |
# overrules the definition found in the source code. |
# Use the PREDEFINED tag if you want to use a different macro definition. |
|
EXPAND_AS_DEFINED = |
|
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
# doxygen's preprocessor will remove all references to function-like macros |
# that are alone on a line, have an all uppercase name, and do not end with a |
# semicolon, because these will confuse the parser if not removed. |
# doxygen's preprocessor will remove all function-like macros that are alone |
# on a line, have an all uppercase name, and do not end with a semicolon. Such |
# function macros are typically used for boiler-plate code, and will confuse |
# the parser if not removed. |
|
SKIP_FUNCTION_MACROS = YES |
|
1542,16 → 1337,20
# Configuration::additions related to external references |
#--------------------------------------------------------------------------- |
|
# The TAGFILES option can be used to specify one or more tagfiles. For each |
# tag file the location of the external documentation should be added. The |
# format of a tag file without this location is as follows: |
# The TAGFILES option can be used to specify one or more tagfiles. |
# Optionally an initial location of the external documentation |
# can be added for each tagfile. The format of a tag file without |
# this location is as follows: |
# TAGFILES = file1 file2 ... |
# Adding location for the tag files is done as follows: |
# TAGFILES = file1=loc1 "file2 = loc2" ... |
# where "loc1" and "loc2" can be relative or absolute paths |
# or URLs. Note that each tag file must have a unique name (where the name does |
# NOT include the path). If a tag file is not located in the directory in which |
# doxygen is run, you must also specify the path to the tagfile here. |
# where "loc1" and "loc2" can be relative or absolute paths or |
# URLs. If a location is present for each tag, the installdox tool |
# does not have to be run to correct the links. |
# Note that each tag file must have a unique name |
# (where the name does NOT include the path) |
# If a tag file is not located in the directory in which doxygen |
# is run, you must also specify the path to the tagfile here. |
|
TAGFILES = |
|
1584,8 → 1383,9
# 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 |
# or super classes. Setting the tag to NO turns the diagrams off. Note that |
# this option also works with HAVE_DOT disabled, but it is recommended to |
# install and use dot, since it yields more powerful graphs. |
# this option is superseded by the HAVE_DOT option below. This is only a |
# fallback. It is recommended to install and use dot, since it yields more |
# powerful graphs. |
|
CLASS_DIAGRAMS = YES |
|
1611,21 → 1411,15
|
HAVE_DOT = NO |
|
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is |
# allowed to run in parallel. When set to 0 (the default) doxygen will |
# base this on the number of processors available in the system. You can set it |
# explicitly to a value larger than 0 to get control over the balance |
# between CPU load and processing speed. |
# By default doxygen will write a font called FreeSans.ttf to the output |
# directory and reference it in all dot files that doxygen generates. This |
# font does not include all possible unicode characters however, so when you need |
# these (or just want a differently looking font) you can specify the font name |
# using DOT_FONTNAME. You need 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 |
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory |
# containing the font. |
|
DOT_NUM_THREADS = 0 |
|
# By default doxygen will use the Helvetica font for 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 DOTFONTPATH environment variable or by setting DOT_FONTPATH to the |
# directory containing the font. |
|
DOT_FONTNAME = Helvetica |
|
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. |
1633,9 → 1427,10
|
DOT_FONTSIZE = 10 |
|
# By default doxygen will tell dot to use the Helvetica font. |
# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to |
# set the path where dot can find it. |
# By default doxygen will tell dot to use the output directory to look for the |
# FreeSans.ttf font (which doxygen will put there itself). If you specify a |
# different font using DOT_FONTNAME you can set the path where dot |
# can find it using this tag. |
|
DOT_FONTPATH = |
|
1642,7 → 1437,7
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
# will generate a graph for each documented class showing the direct and |
# indirect inheritance relations. Setting this tag to YES will force the |
# CLASS_DIAGRAMS tag to NO. |
# the CLASS_DIAGRAMS tag to NO. |
|
CLASS_GRAPH = YES |
|
1664,15 → 1459,6
|
UML_LOOK = NO |
|
# If the UML_LOOK tag is enabled, the fields and methods are shown inside |
# the class node. If there are many fields or methods and many nodes the |
# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS |
# threshold limits the number of items for each type to make the size more |
# managable. Set this to 0 for no limit. Note that the threshold may be |
# exceeded by 50% before the limit is enforced. |
|
UML_LIMIT_NUM_FIELDS = 10 |
|
# If set to YES, the inheritance and collaboration graphs will show the |
# relations between templates and their instances. |
|
1698,7 → 1484,7
# the time of a run. So in most cases it will be better to enable call graphs |
# for selected functions only using the \callgraph command. |
|
CALL_GRAPH = NO |
CALL_GRAPH = YES |
|
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then |
# doxygen will generate a caller dependency graph for every global function |
1706,10 → 1492,10
# the time of a run. So in most cases it will be better to enable caller |
# graphs for selected functions only using the \callergraph command. |
|
CALLER_GRAPH = NO |
CALLER_GRAPH = YES |
|
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
# will generate a graphical hierarchy of all classes instead of a textual one. |
# will graphical hierarchy of all classes instead of a textual one. |
|
GRAPHICAL_HIERARCHY = YES |
|
1721,22 → 1507,11
DIRECTORY_GRAPH = YES |
|
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
# generated by dot. Possible values are svg, png, jpg, or gif. |
# If left blank png will be used. If you choose svg you need to set |
# HTML_FILE_EXTENSION to xhtml in order to make the SVG files |
# visible in IE 9+ (other browsers do not have this requirement). |
# generated by dot. Possible values are png, jpg, or gif |
# If left blank png will be used. |
|
DOT_IMAGE_FORMAT = png |
|
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to |
# enable generation of interactive SVG images that allow zooming and panning. |
# Note that this requires a modern browser other than Internet Explorer. |
# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you |
# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files |
# visible. Older versions of IE do not have SVG support. |
|
INTERACTIVE_SVG = NO |
|
# The tag DOT_PATH can be used to specify the path where the dot tool can be |
# found. If left blank, it is assumed the dot tool can be found in the path. |
|
1748,12 → 1523,6
|
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 |
# 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 |