##// END OF EJS Templates
HG_REPOSITORIES » LPP » INSTRUMENTATION » USERS » PELLION » VHD_Lib
RSS

Clone from http://pc-instru.lpp.polytechnique.fr:5000/VHD_Lib

imporved Doxygen file, and missing lcd file added but not implemented
Alexis -
r2:749c5ca91ebc default
parent child
Show More
Show file before | Show file after | Hide comments
@@ -0,0 +1,64
1 ------------------------------------------------------------------------------
2 -- This file is a part of the LPP VHDL IP LIBRARY
3 -- Copyright (C) 2009 - 2010, Laboratory of Plasmas Physic - CNRS
4 --
5 -- This program is free software; you can redistribute it and/or modify
6 -- it under the terms of the GNU General Public License as published by
7 -- the Free Software Foundation; either version 2 of the License, or
8 -- (at your option) any later version.
9 --
10 -- This program is distributed in the hope that it will be useful,
11 -- but WITHOUT ANY WARRANTY; without even the implied warranty of
12 -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 -- GNU General Public License for more details.
14 --
15 -- You should have received a copy of the GNU General Public License
16 -- along with this program; if not, write to the Free Software
17 -- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 -------------------------------------------------------------------------------
19 ----------------------------------------------------------------------------------
20 -- Company:
21 -- Engineer:
22 --
23 -- Create Date: 10:09:57 10/13/2010
24 -- Design Name:
25 -- Module Name: LCD_2x16_DRIVER - Behavioral
26 -- Project Name:
27 -- Target Devices:
28 -- Tool versions:
29 -- Description:
30 --
31 -- Dependencies:
32 --
33 -- Revision:
34 -- Revision 0.01 - File Created
35 -- Additional Comments:
36 --
37 ----------------------------------------------------------------------------------
38 library IEEE;
39 use IEEE.STD_LOGIC_1164.ALL;
40 use IEEE.NUMERIC_STD.all;
41 library lpp;
42 use lpp.amba_lcd_16x2_ctrlr.all;
43
44
45 entity LCD_16x2_DRIVER is
46 generic(
47 OSC_Freq_MHz : integer:=60
48 );
49 Port ( reset : in STD_LOGIC;
50 clk : in STD_LOGIC;
51 LCD_CTRL : out LCD_DRVR_CTRL_BUSS;
52 SYNCH : out LCD_DRVR_SYNCH_BUSS;
53 DRIVER_CMD : in LCD_DRVR_CMD_BUSS
54 );
55 end LCD_16x2_DRIVER;
56
57 architecture Behavioral of LCD_16x2_DRIVER is
58
59 end Behavioral;
60
61
62
63
64
Show file before | Show file after | Hide comments
@@ -1,36 +1,37
1 all: help
1 all: help
2
2
3 help:
3 help:
4 @echo
4 @echo
5 @echo " batch targets:"
5 @echo " batch targets:"
6 @echo
6 @echo
7 @echo " make Patch-GRLIB : install library into $(GRLIB)"
7 @echo " make Patch-GRLIB : install library into $(GRLIB)"
8 @echo " make dist : create a tar file for using into an other computer"
8 @echo " make dist : create a tar file for using into an other computer"
9 @echo " make Patched-dist : create a tar file for with a patched grlib for using into an other computer"
9 @echo " make Patched-dist : create a tar file for with a patched grlib for using into an other computer"
10 @echo " make allGPL : add a GPL HEADER in all vhdl Files"
10 @echo " make allGPL : add a GPL HEADER in all vhdl Files"
11 @echo " make init : add a GPL HEADER in all vhdl Files, init all files"
11 @echo " make init : add a GPL HEADER in all vhdl Files, init all files"
12 @echo " make doc : make documentation for VHDL IPs"
12 @echo " make doc : make documentation for VHDL IPs"
13 @echo
13 @echo
14
14
15 allGPL:
15 allGPL:
16 sh lib/GPL_Patcher.sh -R
16 sh lib/GPL_Patcher.sh -R
17
17
18 init: allGPL
18 init: allGPL
19 sh lib/lpp/vhdlsynPatcher.sh
19 sh lib/lpp/vhdlsynPatcher.sh
20 sh lib/lpp/makeDirs.sh lib/lpp
20 sh lib/lpp/makeDirs.sh lib/lpp
21
21
22
22
23 Patch-GRLIB: init doc
23 Patch-GRLIB: init doc
24 sh patch.sh $(GRLIB)
24 sh patch.sh $(GRLIB)
25
25
26
26
27 dist: init
27 dist: init
28 tar -cvzf ./../lpp-lib.tgz ./../lib_lpp/*
28 tar -cvzf ./../lpp-lib.tgz ./../lib_lpp/*
29
29
30 Patched-dist: Patch-GRLIB
30 Patched-dist: Patch-GRLIB
31 tar -cvzf ./../lpp-patched-GRLIB.tgz $(GRLIB)/*
31 tar -cvzf ./../lpp-patched-GRLIB.tgz $(GRLIB)/*
32
32
33
33
34 doc:
34 doc:
35 doxygen lib/lpp/Doxyfile
35 doxygen lib/lpp/Doxyfile
36 make lib/lpp/doc/latex
36 make lib/lpp/doc/latex
37 cp lib/lpp/doc/latex/refman.pdf lib/lpp/doc/VHD_lib.pdf
Show file before | Show file after | Hide comments
@@ -1,1661 +1,1661
1 # Doxyfile 1.7.1
1 # Doxyfile 1.7.1
2
2
3 # This file describes the settings to be used by the documentation system
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
4 # doxygen (www.doxygen.org) for a project
5 #
5 #
6 # All text after a hash (#) is considered a comment and will be ignored
6 # All text after a hash (#) is considered a comment and will be ignored
7 # The format is:
7 # The format is:
8 # TAG = value [value, ...]
8 # TAG = value [value, ...]
9 # For lists items can also be appended using:
9 # For lists items can also be appended using:
10 # TAG += value [value, ...]
10 # TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ")
11 # Values that contain spaces should be placed between quotes (" ")
12
12
13 #---------------------------------------------------------------------------
13 #---------------------------------------------------------------------------
14 # Project related configuration options
14 # Project related configuration options
15 #---------------------------------------------------------------------------
15 #---------------------------------------------------------------------------
16
16
17 # This tag specifies the encoding used for all characters in the config file
17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
22
22
23 DOXYFILE_ENCODING = UTF-8
23 DOXYFILE_ENCODING = UTF-8
24
24
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
26 # by quotes) that should identify the project.
27
27
28 PROJECT_NAME = lib-lpp
28 PROJECT_NAME = lib-lpp
29
29
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31 # This could be handy for archiving the generated documentation or
31 # This could be handy for archiving the generated documentation or
32 # if some version control system is used.
32 # if some version control system is used.
33
33
34 PROJECT_NUMBER = 1.0
34 PROJECT_NUMBER = 1.0
35
35
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37 # base path where the generated documentation will be put.
37 # base path where the generated documentation will be put.
38 # If a relative path is entered, it will be relative to the location
38 # If a relative path is entered, it will be relative to the location
39 # where doxygen was started. If left blank the current directory will be used.
39 # where doxygen was started. If left blank the current directory will be used.
40
40
41 OUTPUT_DIRECTORY = /opt/GRLIB/lib_lpp/lib/lpp/doc
41 OUTPUT_DIRECTORY = doc
42
42
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
45 # format and will distribute the generated files over these directories.
45 # format and will distribute the generated files over these directories.
46 # Enabling this option can be useful when feeding doxygen a huge amount of
46 # Enabling this option can be useful when feeding doxygen a huge amount of
47 # source files, where putting all generated files in the same directory would
47 # source files, where putting all generated files in the same directory would
48 # otherwise cause performance problems for the file system.
48 # otherwise cause performance problems for the file system.
49
49
50 CREATE_SUBDIRS = NO
50 CREATE_SUBDIRS = NO
51
51
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53 # documentation generated by doxygen is written. Doxygen will use this
53 # documentation generated by doxygen is written. Doxygen will use this
54 # information to generate all constant output in the proper language.
54 # information to generate all constant output in the proper language.
55 # The default language is English, other supported languages are:
55 # The default language is English, other supported languages are:
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
57 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
62
62
63 OUTPUT_LANGUAGE = English
63 OUTPUT_LANGUAGE = English
64
64
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66 # include brief member descriptions after the members that are listed in
66 # include brief member descriptions after the members that are listed in
67 # the file and class documentation (similar to JavaDoc).
67 # the file and class documentation (similar to JavaDoc).
68 # Set to NO to disable this.
68 # Set to NO to disable this.
69
69
70 BRIEF_MEMBER_DESC = YES
70 BRIEF_MEMBER_DESC = YES
71
71
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73 # the brief description of a member or function before the detailed description.
73 # the brief description of a member or function before the detailed description.
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75 # brief descriptions will be completely suppressed.
75 # brief descriptions will be completely suppressed.
76
76
77 REPEAT_BRIEF = YES
77 REPEAT_BRIEF = YES
78
78
79 # This tag implements a quasi-intelligent brief description abbreviator
79 # This tag implements a quasi-intelligent brief description abbreviator
80 # that is used to form the text in various listings. Each string
80 # that is used to form the text in various listings. Each string
81 # in this list, if found as the leading text of the brief description, will be
81 # in this list, if found as the leading text of the brief description, will be
82 # stripped from the text and the result after processing the whole list, is
82 # stripped from the text and the result after processing the whole list, is
83 # used as the annotated text. Otherwise, the brief description is used as-is.
83 # used as the annotated text. Otherwise, the brief description is used as-is.
84 # If left blank, the following values are used ("$name" is automatically
84 # If left blank, the following values are used ("$name" is automatically
85 # replaced with the name of the entity): "The $name class" "The $name widget"
85 # replaced with the name of the entity): "The $name class" "The $name widget"
86 # "The $name file" "is" "provides" "specifies" "contains"
86 # "The $name file" "is" "provides" "specifies" "contains"
87 # "represents" "a" "an" "the"
87 # "represents" "a" "an" "the"
88
88
89 ABBREVIATE_BRIEF = "The $name class" \
89 ABBREVIATE_BRIEF = "The $name class" \
90 "The $name widget" \
90 "The $name widget" \
91 "The $name file" \
91 "The $name file" \
92 is \
92 is \
93 provides \
93 provides \
94 specifies \
94 specifies \
95 contains \
95 contains \
96 represents \
96 represents \
97 a \
97 a \
98 an \
98 an \
99 the
99 the
100
100
101 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
101 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
102 # Doxygen will generate a detailed section even if there is only a brief
102 # Doxygen will generate a detailed section even if there is only a brief
103 # description.
103 # description.
104
104
105 ALWAYS_DETAILED_SEC = NO
105 ALWAYS_DETAILED_SEC = NO
106
106
107 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
107 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
108 # inherited members of a class in the documentation of that class as if those
108 # inherited members of a class in the documentation of that class as if those
109 # members were ordinary class members. Constructors, destructors and assignment
109 # members were ordinary class members. Constructors, destructors and assignment
110 # operators of the base classes will not be shown.
110 # operators of the base classes will not be shown.
111
111
112 INLINE_INHERITED_MEMB = NO
112 INLINE_INHERITED_MEMB = NO
113
113
114 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
114 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
115 # path before files name in the file list and in the header files. If set
115 # path before files name in the file list and in the header files. If set
116 # to NO the shortest path that makes the file name unique will be used.
116 # to NO the shortest path that makes the file name unique will be used.
117
117
118 FULL_PATH_NAMES = YES
118 FULL_PATH_NAMES = YES
119
119
120 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
120 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
121 # can be used to strip a user-defined part of the path. Stripping is
121 # can be used to strip a user-defined part of the path. Stripping is
122 # only done if one of the specified strings matches the left-hand part of
122 # only done if one of the specified strings matches the left-hand part of
123 # the path. The tag can be used to show relative paths in the file list.
123 # the path. The tag can be used to show relative paths in the file list.
124 # If left blank the directory from which doxygen is run is used as the
124 # If left blank the directory from which doxygen is run is used as the
125 # path to strip.
125 # path to strip.
126
126
127 STRIP_FROM_PATH =
127 STRIP_FROM_PATH =
128
128
129 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
129 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
130 # the path mentioned in the documentation of a class, which tells
130 # the path mentioned in the documentation of a class, which tells
131 # the reader which header file to include in order to use a class.
131 # the reader which header file to include in order to use a class.
132 # If left blank only the name of the header file containing the class
132 # If left blank only the name of the header file containing the class
133 # definition is used. Otherwise one should specify the include paths that
133 # definition is used. Otherwise one should specify the include paths that
134 # are normally passed to the compiler using the -I flag.
134 # are normally passed to the compiler using the -I flag.
135
135
136 STRIP_FROM_INC_PATH =
136 STRIP_FROM_INC_PATH =
137
137
138 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
138 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
139 # (but less readable) file names. This can be useful is your file systems
139 # (but less readable) file names. This can be useful is your file systems
140 # doesn't support long names like on DOS, Mac, or CD-ROM.
140 # doesn't support long names like on DOS, Mac, or CD-ROM.
141
141
142 SHORT_NAMES = NO
142 SHORT_NAMES = NO
143
143
144 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
144 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
145 # will interpret the first line (until the first dot) of a JavaDoc-style
145 # will interpret the first line (until the first dot) of a JavaDoc-style
146 # comment as the brief description. If set to NO, the JavaDoc
146 # comment as the brief description. If set to NO, the JavaDoc
147 # comments will behave just like regular Qt-style comments
147 # comments will behave just like regular Qt-style comments
148 # (thus requiring an explicit @brief command for a brief description.)
148 # (thus requiring an explicit @brief command for a brief description.)
149
149
150 JAVADOC_AUTOBRIEF = NO
150 JAVADOC_AUTOBRIEF = NO
151
151
152 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
152 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
153 # interpret the first line (until the first dot) of a Qt-style
153 # interpret the first line (until the first dot) of a Qt-style
154 # comment as the brief description. If set to NO, the comments
154 # comment as the brief description. If set to NO, the comments
155 # will behave just like regular Qt-style comments (thus requiring
155 # will behave just like regular Qt-style comments (thus requiring
156 # an explicit \brief command for a brief description.)
156 # an explicit \brief command for a brief description.)
157
157
158 QT_AUTOBRIEF = NO
158 QT_AUTOBRIEF = NO
159
159
160 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
160 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
161 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
161 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
162 # comments) as a brief description. This used to be the default behaviour.
162 # comments) as a brief description. This used to be the default behaviour.
163 # The new default is to treat a multi-line C++ comment block as a detailed
163 # The new default is to treat a multi-line C++ comment block as a detailed
164 # description. Set this tag to YES if you prefer the old behaviour instead.
164 # description. Set this tag to YES if you prefer the old behaviour instead.
165
165
166 MULTILINE_CPP_IS_BRIEF = NO
166 MULTILINE_CPP_IS_BRIEF = NO
167
167
168 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
168 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
169 # member inherits the documentation from any documented member that it
169 # member inherits the documentation from any documented member that it
170 # re-implements.
170 # re-implements.
171
171
172 INHERIT_DOCS = YES
172 INHERIT_DOCS = YES
173
173
174 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
174 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
175 # a new page for each member. If set to NO, the documentation of a member will
175 # a new page for each member. If set to NO, the documentation of a member will
176 # be part of the file/class/namespace that contains it.
176 # be part of the file/class/namespace that contains it.
177
177
178 SEPARATE_MEMBER_PAGES = NO
178 SEPARATE_MEMBER_PAGES = NO
179
179
180 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
180 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
181 # Doxygen uses this value to replace tabs by spaces in code fragments.
181 # Doxygen uses this value to replace tabs by spaces in code fragments.
182
182
183 TAB_SIZE = 8
183 TAB_SIZE = 8
184
184
185 # This tag can be used to specify a number of aliases that acts
185 # This tag can be used to specify a number of aliases that acts
186 # as commands in the documentation. An alias has the form "name=value".
186 # as commands in the documentation. An alias has the form "name=value".
187 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
187 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
188 # put the command \sideeffect (or @sideeffect) in the documentation, which
188 # put the command \sideeffect (or @sideeffect) in the documentation, which
189 # will result in a user-defined paragraph with heading "Side Effects:".
189 # will result in a user-defined paragraph with heading "Side Effects:".
190 # You can put \n's in the value part of an alias to insert newlines.
190 # You can put \n's in the value part of an alias to insert newlines.
191
191
192 ALIASES =
192 ALIASES =
193
193
194 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
194 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
195 # sources only. Doxygen will then generate output that is more tailored for C.
195 # sources only. Doxygen will then generate output that is more tailored for C.
196 # For instance, some of the names that are used will be different. The list
196 # For instance, some of the names that are used will be different. The list
197 # of all members will be omitted, etc.
197 # of all members will be omitted, etc.
198
198
199 OPTIMIZE_OUTPUT_FOR_C = NO
199 OPTIMIZE_OUTPUT_FOR_C = NO
200
200
201 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
201 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
202 # sources only. Doxygen will then generate output that is more tailored for
202 # sources only. Doxygen will then generate output that is more tailored for
203 # Java. For instance, namespaces will be presented as packages, qualified
203 # Java. For instance, namespaces will be presented as packages, qualified
204 # scopes will look different, etc.
204 # scopes will look different, etc.
205
205
206 OPTIMIZE_OUTPUT_JAVA = NO
206 OPTIMIZE_OUTPUT_JAVA = NO
207
207
208 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
208 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
209 # sources only. Doxygen will then generate output that is more tailored for
209 # sources only. Doxygen will then generate output that is more tailored for
210 # Fortran.
210 # Fortran.
211
211
212 OPTIMIZE_FOR_FORTRAN = NO
212 OPTIMIZE_FOR_FORTRAN = NO
213
213
214 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
214 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
215 # sources. Doxygen will then generate output that is tailored for
215 # sources. Doxygen will then generate output that is tailored for
216 # VHDL.
216 # VHDL.
217
217
218 OPTIMIZE_OUTPUT_VHDL = YES
218 OPTIMIZE_OUTPUT_VHDL = YES
219
219
220 # Doxygen selects the parser to use depending on the extension of the files it
220 # Doxygen selects the parser to use depending on the extension of the files it
221 # parses. With this tag you can assign which parser to use for a given extension.
221 # parses. With this tag you can assign which parser to use for a given extension.
222 # Doxygen has a built-in mapping, but you can override or extend it using this
222 # Doxygen has a built-in mapping, but you can override or extend it using this
223 # tag. The format is ext=language, where ext is a file extension, and language
223 # tag. The format is ext=language, where ext is a file extension, and language
224 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
224 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
225 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
225 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
226 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
226 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
227 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
227 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
228 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
228 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
229
229
230 EXTENSION_MAPPING =
230 EXTENSION_MAPPING =
231
231
232 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
232 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
233 # to include (a tag file for) the STL sources as input, then you should
233 # to include (a tag file for) the STL sources as input, then you should
234 # set this tag to YES in order to let doxygen match functions declarations and
234 # set this tag to YES in order to let doxygen match functions declarations and
235 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
235 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
236 # func(std::string) {}). This also make the inheritance and collaboration
236 # func(std::string) {}). This also make the inheritance and collaboration
237 # diagrams that involve STL classes more complete and accurate.
237 # diagrams that involve STL classes more complete and accurate.
238
238
239 BUILTIN_STL_SUPPORT = NO
239 BUILTIN_STL_SUPPORT = NO
240
240
241 # If you use Microsoft's C++/CLI language, you should set this option to YES to
241 # If you use Microsoft's C++/CLI language, you should set this option to YES to
242 # enable parsing support.
242 # enable parsing support.
243
243
244 CPP_CLI_SUPPORT = NO
244 CPP_CLI_SUPPORT = NO
245
245
246 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
246 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
247 # Doxygen will parse them like normal C++ but will assume all classes use public
247 # Doxygen will parse them like normal C++ but will assume all classes use public
248 # instead of private inheritance when no explicit protection keyword is present.
248 # instead of private inheritance when no explicit protection keyword is present.
249
249
250 SIP_SUPPORT = NO
250 SIP_SUPPORT = NO
251
251
252 # For Microsoft's IDL there are propget and propput attributes to indicate getter
252 # For Microsoft's IDL there are propget and propput attributes to indicate getter
253 # and setter methods for a property. Setting this option to YES (the default)
253 # and setter methods for a property. Setting this option to YES (the default)
254 # will make doxygen to replace the get and set methods by a property in the
254 # will make doxygen to replace the get and set methods by a property in the
255 # documentation. This will only work if the methods are indeed getting or
255 # documentation. This will only work if the methods are indeed getting or
256 # setting a simple type. If this is not the case, or you want to show the
256 # setting a simple type. If this is not the case, or you want to show the
257 # methods anyway, you should set this option to NO.
257 # methods anyway, you should set this option to NO.
258
258
259 IDL_PROPERTY_SUPPORT = YES
259 IDL_PROPERTY_SUPPORT = YES
260
260
261 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
261 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
262 # tag is set to YES, then doxygen will reuse the documentation of the first
262 # tag is set to YES, then doxygen will reuse the documentation of the first
263 # member in the group (if any) for the other members of the group. By default
263 # member in the group (if any) for the other members of the group. By default
264 # all members of a group must be documented explicitly.
264 # all members of a group must be documented explicitly.
265
265
266 DISTRIBUTE_GROUP_DOC = NO
266 DISTRIBUTE_GROUP_DOC = NO
267
267
268 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
268 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
269 # the same type (for instance a group of public functions) to be put as a
269 # the same type (for instance a group of public functions) to be put as a
270 # subgroup of that type (e.g. under the Public Functions section). Set it to
270 # subgroup of that type (e.g. under the Public Functions section). Set it to
271 # NO to prevent subgrouping. Alternatively, this can be done per class using
271 # NO to prevent subgrouping. Alternatively, this can be done per class using
272 # the \nosubgrouping command.
272 # the \nosubgrouping command.
273
273
274 SUBGROUPING = YES
274 SUBGROUPING = YES
275
275
276 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
276 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
277 # is documented as struct, union, or enum with the name of the typedef. So
277 # is documented as struct, union, or enum with the name of the typedef. So
278 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
278 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
279 # with name TypeT. When disabled the typedef will appear as a member of a file,
279 # with name TypeT. When disabled the typedef will appear as a member of a file,
280 # namespace, or class. And the struct will be named TypeS. This can typically
280 # namespace, or class. And the struct will be named TypeS. This can typically
281 # be useful for C code in case the coding convention dictates that all compound
281 # be useful for C code in case the coding convention dictates that all compound
282 # types are typedef'ed and only the typedef is referenced, never the tag name.
282 # types are typedef'ed and only the typedef is referenced, never the tag name.
283
283
284 TYPEDEF_HIDES_STRUCT = NO
284 TYPEDEF_HIDES_STRUCT = NO
285
285
286 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
286 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
287 # determine which symbols to keep in memory and which to flush to disk.
287 # determine which symbols to keep in memory and which to flush to disk.
288 # When the cache is full, less often used symbols will be written to disk.
288 # When the cache is full, less often used symbols will be written to disk.
289 # For small to medium size projects (<1000 input files) the default value is
289 # For small to medium size projects (<1000 input files) the default value is
290 # probably good enough. For larger projects a too small cache size can cause
290 # probably good enough. For larger projects a too small cache size can cause
291 # doxygen to be busy swapping symbols to and from disk most of the time
291 # doxygen to be busy swapping symbols to and from disk most of the time
292 # causing a significant performance penality.
292 # causing a significant performance penality.
293 # If the system has enough physical memory increasing the cache will improve the
293 # If the system has enough physical memory increasing the cache will improve the
294 # performance by keeping more symbols in memory. Note that the value works on
294 # performance by keeping more symbols in memory. Note that the value works on
295 # a logarithmic scale so increasing the size by one will rougly double the
295 # a logarithmic scale so increasing the size by one will rougly double the
296 # memory usage. The cache size is given by this formula:
296 # memory usage. The cache size is given by this formula:
297 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
297 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
298 # corresponding to a cache size of 2^16 = 65536 symbols
298 # corresponding to a cache size of 2^16 = 65536 symbols
299
299
300 SYMBOL_CACHE_SIZE = 0
300 SYMBOL_CACHE_SIZE = 0
301
301
302 #---------------------------------------------------------------------------
302 #---------------------------------------------------------------------------
303 # Build related configuration options
303 # Build related configuration options
304 #---------------------------------------------------------------------------
304 #---------------------------------------------------------------------------
305
305
306 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
306 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
307 # documentation are documented, even if no documentation was available.
307 # documentation are documented, even if no documentation was available.
308 # Private class members and static file members will be hidden unless
308 # Private class members and static file members will be hidden unless
309 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
309 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
310
310
311 EXTRACT_ALL = YES
311 EXTRACT_ALL = YES
312
312
313 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
313 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
314 # will be included in the documentation.
314 # will be included in the documentation.
315
315
316 EXTRACT_PRIVATE = NO
316 EXTRACT_PRIVATE = NO
317
317
318 # If the EXTRACT_STATIC tag is set to YES all static members of a file
318 # If the EXTRACT_STATIC tag is set to YES all static members of a file
319 # will be included in the documentation.
319 # will be included in the documentation.
320
320
321 EXTRACT_STATIC = NO
321 EXTRACT_STATIC = NO
322
322
323 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
323 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
324 # defined locally in source files will be included in the documentation.
324 # defined locally in source files will be included in the documentation.
325 # If set to NO only classes defined in header files are included.
325 # If set to NO only classes defined in header files are included.
326
326
327 EXTRACT_LOCAL_CLASSES = YES
327 EXTRACT_LOCAL_CLASSES = YES
328
328
329 # This flag is only useful for Objective-C code. When set to YES local
329 # This flag is only useful for Objective-C code. When set to YES local
330 # methods, which are defined in the implementation section but not in
330 # methods, which are defined in the implementation section but not in
331 # the interface are included in the documentation.
331 # the interface are included in the documentation.
332 # If set to NO (the default) only methods in the interface are included.
332 # If set to NO (the default) only methods in the interface are included.
333
333
334 EXTRACT_LOCAL_METHODS = NO
334 EXTRACT_LOCAL_METHODS = NO
335
335
336 # If this flag is set to YES, the members of anonymous namespaces will be
336 # If this flag is set to YES, the members of anonymous namespaces will be
337 # extracted and appear in the documentation as a namespace called
337 # extracted and appear in the documentation as a namespace called
338 # 'anonymous_namespace{file}', where file will be replaced with the base
338 # 'anonymous_namespace{file}', where file will be replaced with the base
339 # name of the file that contains the anonymous namespace. By default
339 # name of the file that contains the anonymous namespace. By default
340 # anonymous namespace are hidden.
340 # anonymous namespace are hidden.
341
341
342 EXTRACT_ANON_NSPACES = NO
342 EXTRACT_ANON_NSPACES = NO
343
343
344 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
344 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
345 # undocumented members of documented classes, files or namespaces.
345 # undocumented members of documented classes, files or namespaces.
346 # If set to NO (the default) these members will be included in the
346 # If set to NO (the default) these members will be included in the
347 # various overviews, but no documentation section is generated.
347 # various overviews, but no documentation section is generated.
348 # This option has no effect if EXTRACT_ALL is enabled.
348 # This option has no effect if EXTRACT_ALL is enabled.
349
349
350 HIDE_UNDOC_MEMBERS = NO
350 HIDE_UNDOC_MEMBERS = NO
351
351
352 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
352 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
353 # undocumented classes that are normally visible in the class hierarchy.
353 # undocumented classes that are normally visible in the class hierarchy.
354 # If set to NO (the default) these classes will be included in the various
354 # If set to NO (the default) these classes will be included in the various
355 # overviews. This option has no effect if EXTRACT_ALL is enabled.
355 # overviews. This option has no effect if EXTRACT_ALL is enabled.
356
356
357 HIDE_UNDOC_CLASSES = NO
357 HIDE_UNDOC_CLASSES = NO
358
358
359 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
359 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
360 # friend (class|struct|union) declarations.
360 # friend (class|struct|union) declarations.
361 # If set to NO (the default) these declarations will be included in the
361 # If set to NO (the default) these declarations will be included in the
362 # documentation.
362 # documentation.
363
363
364 HIDE_FRIEND_COMPOUNDS = NO
364 HIDE_FRIEND_COMPOUNDS = NO
365
365
366 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
366 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
367 # documentation blocks found inside the body of a function.
367 # documentation blocks found inside the body of a function.
368 # If set to NO (the default) these blocks will be appended to the
368 # If set to NO (the default) these blocks will be appended to the
369 # function's detailed documentation block.
369 # function's detailed documentation block.
370
370
371 HIDE_IN_BODY_DOCS = NO
371 HIDE_IN_BODY_DOCS = NO
372
372
373 # The INTERNAL_DOCS tag determines if documentation
373 # The INTERNAL_DOCS tag determines if documentation
374 # that is typed after a \internal command is included. If the tag is set
374 # that is typed after a \internal command is included. If the tag is set
375 # to NO (the default) then the documentation will be excluded.
375 # to NO (the default) then the documentation will be excluded.
376 # Set it to YES to include the internal documentation.
376 # Set it to YES to include the internal documentation.
377
377
378 INTERNAL_DOCS = NO
378 INTERNAL_DOCS = NO
379
379
380 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
380 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
381 # file names in lower-case letters. If set to YES upper-case letters are also
381 # file names in lower-case letters. If set to YES upper-case letters are also
382 # allowed. This is useful if you have classes or files whose names only differ
382 # allowed. This is useful if you have classes or files whose names only differ
383 # in case and if your file system supports case sensitive file names. Windows
383 # in case and if your file system supports case sensitive file names. Windows
384 # and Mac users are advised to set this option to NO.
384 # and Mac users are advised to set this option to NO.
385
385
386 CASE_SENSE_NAMES = NO
386 CASE_SENSE_NAMES = NO
387
387
388 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
388 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
389 # will show members with their full class and namespace scopes in the
389 # will show members with their full class and namespace scopes in the
390 # documentation. If set to YES the scope will be hidden.
390 # documentation. If set to YES the scope will be hidden.
391
391
392 HIDE_SCOPE_NAMES = NO
392 HIDE_SCOPE_NAMES = NO
393
393
394 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
394 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
395 # will put a list of the files that are included by a file in the documentation
395 # will put a list of the files that are included by a file in the documentation
396 # of that file.
396 # of that file.
397
397
398 SHOW_INCLUDE_FILES = YES
398 SHOW_INCLUDE_FILES = YES
399
399
400 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
400 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
401 # will list include files with double quotes in the documentation
401 # will list include files with double quotes in the documentation
402 # rather than with sharp brackets.
402 # rather than with sharp brackets.
403
403
404 FORCE_LOCAL_INCLUDES = NO
404 FORCE_LOCAL_INCLUDES = NO
405
405
406 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
406 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
407 # is inserted in the documentation for inline members.
407 # is inserted in the documentation for inline members.
408
408
409 INLINE_INFO = YES
409 INLINE_INFO = YES
410
410
411 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
411 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
412 # will sort the (detailed) documentation of file and class members
412 # will sort the (detailed) documentation of file and class members
413 # alphabetically by member name. If set to NO the members will appear in
413 # alphabetically by member name. If set to NO the members will appear in
414 # declaration order.
414 # declaration order.
415
415
416 SORT_MEMBER_DOCS = YES
416 SORT_MEMBER_DOCS = YES
417
417
418 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
418 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
419 # brief documentation of file, namespace and class members alphabetically
419 # brief documentation of file, namespace and class members alphabetically
420 # by member name. If set to NO (the default) the members will appear in
420 # by member name. If set to NO (the default) the members will appear in
421 # declaration order.
421 # declaration order.
422
422
423 SORT_BRIEF_DOCS = NO
423 SORT_BRIEF_DOCS = NO
424
424
425 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
425 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
426 # will sort the (brief and detailed) documentation of class members so that
426 # will sort the (brief and detailed) documentation of class members so that
427 # constructors and destructors are listed first. If set to NO (the default)
427 # constructors and destructors are listed first. If set to NO (the default)
428 # the constructors will appear in the respective orders defined by
428 # the constructors will appear in the respective orders defined by
429 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
429 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
430 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
430 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
431 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
431 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
432
432
433 SORT_MEMBERS_CTORS_1ST = NO
433 SORT_MEMBERS_CTORS_1ST = NO
434
434
435 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
435 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
436 # hierarchy of group names into alphabetical order. If set to NO (the default)
436 # hierarchy of group names into alphabetical order. If set to NO (the default)
437 # the group names will appear in their defined order.
437 # the group names will appear in their defined order.
438
438
439 SORT_GROUP_NAMES = NO
439 SORT_GROUP_NAMES = NO
440
440
441 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
441 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
442 # sorted by fully-qualified names, including namespaces. If set to
442 # sorted by fully-qualified names, including namespaces. If set to
443 # NO (the default), the class list will be sorted only by class name,
443 # NO (the default), the class list will be sorted only by class name,
444 # not including the namespace part.
444 # not including the namespace part.
445 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
445 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
446 # Note: This option applies only to the class list, not to the
446 # Note: This option applies only to the class list, not to the
447 # alphabetical list.
447 # alphabetical list.
448
448
449 SORT_BY_SCOPE_NAME = NO
449 SORT_BY_SCOPE_NAME = NO
450
450
451 # The GENERATE_TODOLIST tag can be used to enable (YES) or
451 # The GENERATE_TODOLIST tag can be used to enable (YES) or
452 # disable (NO) the todo list. This list is created by putting \todo
452 # disable (NO) the todo list. This list is created by putting \todo
453 # commands in the documentation.
453 # commands in the documentation.
454
454
455 GENERATE_TODOLIST = YES
455 GENERATE_TODOLIST = YES
456
456
457 # The GENERATE_TESTLIST tag can be used to enable (YES) or
457 # The GENERATE_TESTLIST tag can be used to enable (YES) or
458 # disable (NO) the test list. This list is created by putting \test
458 # disable (NO) the test list. This list is created by putting \test
459 # commands in the documentation.
459 # commands in the documentation.
460
460
461 GENERATE_TESTLIST = YES
461 GENERATE_TESTLIST = YES
462
462
463 # The GENERATE_BUGLIST tag can be used to enable (YES) or
463 # The GENERATE_BUGLIST tag can be used to enable (YES) or
464 # disable (NO) the bug list. This list is created by putting \bug
464 # disable (NO) the bug list. This list is created by putting \bug
465 # commands in the documentation.
465 # commands in the documentation.
466
466
467 GENERATE_BUGLIST = YES
467 GENERATE_BUGLIST = YES
468
468
469 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
469 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
470 # disable (NO) the deprecated list. This list is created by putting
470 # disable (NO) the deprecated list. This list is created by putting
471 # \deprecated commands in the documentation.
471 # \deprecated commands in the documentation.
472
472
473 GENERATE_DEPRECATEDLIST= YES
473 GENERATE_DEPRECATEDLIST= YES
474
474
475 # The ENABLED_SECTIONS tag can be used to enable conditional
475 # The ENABLED_SECTIONS tag can be used to enable conditional
476 # documentation sections, marked by \if sectionname ... \endif.
476 # documentation sections, marked by \if sectionname ... \endif.
477
477
478 ENABLED_SECTIONS =
478 ENABLED_SECTIONS =
479
479
480 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
480 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
481 # the initial value of a variable or define consists of for it to appear in
481 # the initial value of a variable or define consists of for it to appear in
482 # the documentation. If the initializer consists of more lines than specified
482 # the documentation. If the initializer consists of more lines than specified
483 # here it will be hidden. Use a value of 0 to hide initializers completely.
483 # here it will be hidden. Use a value of 0 to hide initializers completely.
484 # The appearance of the initializer of individual variables and defines in the
484 # The appearance of the initializer of individual variables and defines in the
485 # documentation can be controlled using \showinitializer or \hideinitializer
485 # documentation can be controlled using \showinitializer or \hideinitializer
486 # command in the documentation regardless of this setting.
486 # command in the documentation regardless of this setting.
487
487
488 MAX_INITIALIZER_LINES = 30
488 MAX_INITIALIZER_LINES = 30
489
489
490 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
490 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
491 # at the bottom of the documentation of classes and structs. If set to YES the
491 # at the bottom of the documentation of classes and structs. If set to YES the
492 # list will mention the files that were used to generate the documentation.
492 # list will mention the files that were used to generate the documentation.
493
493
494 SHOW_USED_FILES = YES
494 SHOW_USED_FILES = YES
495
495
496 # If the sources in your project are distributed over multiple directories
496 # If the sources in your project are distributed over multiple directories
497 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
497 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
498 # in the documentation. The default is NO.
498 # in the documentation. The default is NO.
499
499
500 SHOW_DIRECTORIES = NO
500 SHOW_DIRECTORIES = NO
501
501
502 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
502 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
503 # This will remove the Files entry from the Quick Index and from the
503 # This will remove the Files entry from the Quick Index and from the
504 # Folder Tree View (if specified). The default is YES.
504 # Folder Tree View (if specified). The default is YES.
505
505
506 SHOW_FILES = YES
506 SHOW_FILES = YES
507
507
508 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
508 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
509 # Namespaces page. This will remove the Namespaces entry from the Quick Index
509 # Namespaces page. This will remove the Namespaces entry from the Quick Index
510 # and from the Folder Tree View (if specified). The default is YES.
510 # and from the Folder Tree View (if specified). The default is YES.
511
511
512 SHOW_NAMESPACES = YES
512 SHOW_NAMESPACES = YES
513
513
514 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
514 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
515 # doxygen should invoke to get the current version for each file (typically from
515 # doxygen should invoke to get the current version for each file (typically from
516 # the version control system). Doxygen will invoke the program by executing (via
516 # the version control system). Doxygen will invoke the program by executing (via
517 # popen()) the command <command> <input-file>, where <command> is the value of
517 # popen()) the command <command> <input-file>, where <command> is the value of
518 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
518 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
519 # provided by doxygen. Whatever the program writes to standard output
519 # provided by doxygen. Whatever the program writes to standard output
520 # is used as the file version. See the manual for examples.
520 # is used as the file version. See the manual for examples.
521
521
522 FILE_VERSION_FILTER =
522 FILE_VERSION_FILTER =
523
523
524 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
524 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
525 # by doxygen. The layout file controls the global structure of the generated
525 # by doxygen. The layout file controls the global structure of the generated
526 # output files in an output format independent way. The create the layout file
526 # output files in an output format independent way. The create the layout file
527 # that represents doxygen's defaults, run doxygen with the -l option.
527 # that represents doxygen's defaults, run doxygen with the -l option.
528 # You can optionally specify a file name after the option, if omitted
528 # You can optionally specify a file name after the option, if omitted
529 # DoxygenLayout.xml will be used as the name of the layout file.
529 # DoxygenLayout.xml will be used as the name of the layout file.
530
530
531 LAYOUT_FILE =
531 LAYOUT_FILE =
532
532
533 #---------------------------------------------------------------------------
533 #---------------------------------------------------------------------------
534 # configuration options related to warning and progress messages
534 # configuration options related to warning and progress messages
535 #---------------------------------------------------------------------------
535 #---------------------------------------------------------------------------
536
536
537 # The QUIET tag can be used to turn on/off the messages that are generated
537 # The QUIET tag can be used to turn on/off the messages that are generated
538 # by doxygen. Possible values are YES and NO. If left blank NO is used.
538 # by doxygen. Possible values are YES and NO. If left blank NO is used.
539
539
540 QUIET = NO
540 QUIET = NO
541
541
542 # The WARNINGS tag can be used to turn on/off the warning messages that are
542 # The WARNINGS tag can be used to turn on/off the warning messages that are
543 # generated by doxygen. Possible values are YES and NO. If left blank
543 # generated by doxygen. Possible values are YES and NO. If left blank
544 # NO is used.
544 # NO is used.
545
545
546 WARNINGS = YES
546 WARNINGS = YES
547
547
548 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
548 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
549 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
549 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
550 # automatically be disabled.
550 # automatically be disabled.
551
551
552 WARN_IF_UNDOCUMENTED = YES
552 WARN_IF_UNDOCUMENTED = YES
553
553
554 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
554 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
555 # potential errors in the documentation, such as not documenting some
555 # potential errors in the documentation, such as not documenting some
556 # parameters in a documented function, or documenting parameters that
556 # parameters in a documented function, or documenting parameters that
557 # don't exist or using markup commands wrongly.
557 # don't exist or using markup commands wrongly.
558
558
559 WARN_IF_DOC_ERROR = YES
559 WARN_IF_DOC_ERROR = YES
560
560
561 # This WARN_NO_PARAMDOC option can be abled to get warnings for
561 # This WARN_NO_PARAMDOC option can be abled to get warnings for
562 # functions that are documented, but have no documentation for their parameters
562 # functions that are documented, but have no documentation for their parameters
563 # or return value. If set to NO (the default) doxygen will only warn about
563 # or return value. If set to NO (the default) doxygen will only warn about
564 # wrong or incomplete parameter documentation, but not about the absence of
564 # wrong or incomplete parameter documentation, but not about the absence of
565 # documentation.
565 # documentation.
566
566
567 WARN_NO_PARAMDOC = NO
567 WARN_NO_PARAMDOC = NO
568
568
569 # The WARN_FORMAT tag determines the format of the warning messages that
569 # The WARN_FORMAT tag determines the format of the warning messages that
570 # doxygen can produce. The string should contain the $file, $line, and $text
570 # doxygen can produce. The string should contain the $file, $line, and $text
571 # tags, which will be replaced by the file and line number from which the
571 # tags, which will be replaced by the file and line number from which the
572 # warning originated and the warning text. Optionally the format may contain
572 # warning originated and the warning text. Optionally the format may contain
573 # $version, which will be replaced by the version of the file (if it could
573 # $version, which will be replaced by the version of the file (if it could
574 # be obtained via FILE_VERSION_FILTER)
574 # be obtained via FILE_VERSION_FILTER)
575
575
576 WARN_FORMAT = "$file:$line: $text"
576 WARN_FORMAT = "$file:$line: $text"
577
577
578 # The WARN_LOGFILE tag can be used to specify a file to which warning
578 # The WARN_LOGFILE tag can be used to specify a file to which warning
579 # and error messages should be written. If left blank the output is written
579 # and error messages should be written. If left blank the output is written
580 # to stderr.
580 # to stderr.
581
581
582 WARN_LOGFILE =
582 WARN_LOGFILE =
583
583
584 #---------------------------------------------------------------------------
584 #---------------------------------------------------------------------------
585 # configuration options related to the input files
585 # configuration options related to the input files
586 #---------------------------------------------------------------------------
586 #---------------------------------------------------------------------------
587
587
588 # The INPUT tag can be used to specify the files and/or directories that contain
588 # The INPUT tag can be used to specify the files and/or directories that contain
589 # documented source files. You may enter file names like "myfile.cpp" or
589 # documented source files. You may enter file names like "myfile.cpp" or
590 # directories like "/usr/src/myproject". Separate the files or directories
590 # directories like "/usr/src/myproject". Separate the files or directories
591 # with spaces.
591 # with spaces.
592
592
593 INPUT = /opt/GRLIB/lib_lpp/lib/lpp
593 INPUT = .
594
594
595 # This tag can be used to specify the character encoding of the source files
595 # This tag can be used to specify the character encoding of the source files
596 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
596 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
597 # also the default input encoding. Doxygen uses libiconv (or the iconv built
597 # also the default input encoding. Doxygen uses libiconv (or the iconv built
598 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
598 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
599 # the list of possible encodings.
599 # the list of possible encodings.
600
600
601 INPUT_ENCODING = UTF-8
601 INPUT_ENCODING = UTF-8
602
602
603 # If the value of the INPUT tag contains directories, you can use the
603 # If the value of the INPUT tag contains directories, you can use the
604 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
604 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
605 # and *.h) to filter out the source-files in the directories. If left
605 # and *.h) to filter out the source-files in the directories. If left
606 # blank the following patterns are tested:
606 # blank the following patterns are tested:
607 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
607 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
608 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
608 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
609
609
610 FILE_PATTERNS = *.c \
610 FILE_PATTERNS = *.c \
611 *.cc \
611 *.cc \
612 *.cxx \
612 *.cxx \
613 *.cpp \
613 *.cpp \
614 *.c++ \
614 *.c++ \
615 *.d \
615 *.d \
616 *.java \
616 *.java \
617 *.ii \
617 *.ii \
618 *.ixx \
618 *.ixx \
619 *.ipp \
619 *.ipp \
620 *.i++ \
620 *.i++ \
621 *.inl \
621 *.inl \
622 *.h \
622 *.h \
623 *.hh \
623 *.hh \
624 *.hxx \
624 *.hxx \
625 *.hpp \
625 *.hpp \
626 *.h++ \
626 *.h++ \
627 *.idl \
627 *.idl \
628 *.odl \
628 *.odl \
629 *.cs \
629 *.cs \
630 *.php \
630 *.php \
631 *.php3 \
631 *.php3 \
632 *.inc \
632 *.inc \
633 *.m \
633 *.m \
634 *.mm \
634 *.mm \
635 *.dox \
635 *.dox \
636 *.py \
636 *.py \
637 *.f90 \
637 *.f90 \
638 *.f \
638 *.f \
639 *.vhd \
639 *.vhd \
640 *.vhdl
640 *.vhdl
641
641
642 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
642 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
643 # should be searched for input files as well. Possible values are YES and NO.
643 # should be searched for input files as well. Possible values are YES and NO.
644 # If left blank NO is used.
644 # If left blank NO is used.
645
645
646 RECURSIVE = YES
646 RECURSIVE = YES
647
647
648 # The EXCLUDE tag can be used to specify files and/or directories that should
648 # The EXCLUDE tag can be used to specify files and/or directories that should
649 # excluded from the INPUT source files. This way you can easily exclude a
649 # excluded from the INPUT source files. This way you can easily exclude a
650 # subdirectory from a directory tree whose root is specified with the INPUT tag.
650 # subdirectory from a directory tree whose root is specified with the INPUT tag.
651
651
652 EXCLUDE =
652 EXCLUDE =
653
653
654 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
654 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
655 # directories that are symbolic links (a Unix filesystem feature) are excluded
655 # directories that are symbolic links (a Unix filesystem feature) are excluded
656 # from the input.
656 # from the input.
657
657
658 EXCLUDE_SYMLINKS = NO
658 EXCLUDE_SYMLINKS = NO
659
659
660 # If the value of the INPUT tag contains directories, you can use the
660 # If the value of the INPUT tag contains directories, you can use the
661 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
661 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
662 # certain files from those directories. Note that the wildcards are matched
662 # certain files from those directories. Note that the wildcards are matched
663 # against the file with absolute path, so to exclude all test directories
663 # against the file with absolute path, so to exclude all test directories
664 # for example use the pattern */test/*
664 # for example use the pattern */test/*
665
665
666 EXCLUDE_PATTERNS =
666 EXCLUDE_PATTERNS =
667
667
668 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
668 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
669 # (namespaces, classes, functions, etc.) that should be excluded from the
669 # (namespaces, classes, functions, etc.) that should be excluded from the
670 # output. The symbol name can be a fully qualified name, a word, or if the
670 # output. The symbol name can be a fully qualified name, a word, or if the
671 # wildcard * is used, a substring. Examples: ANamespace, AClass,
671 # wildcard * is used, a substring. Examples: ANamespace, AClass,
672 # AClass::ANamespace, ANamespace::*Test
672 # AClass::ANamespace, ANamespace::*Test
673
673
674 EXCLUDE_SYMBOLS =
674 EXCLUDE_SYMBOLS =
675
675
676 # The EXAMPLE_PATH tag can be used to specify one or more files or
676 # The EXAMPLE_PATH tag can be used to specify one or more files or
677 # directories that contain example code fragments that are included (see
677 # directories that contain example code fragments that are included (see
678 # the \include command).
678 # the \include command).
679
679
680 EXAMPLE_PATH =
680 EXAMPLE_PATH =
681
681
682 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
682 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
683 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
683 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
684 # and *.h) to filter out the source-files in the directories. If left
684 # and *.h) to filter out the source-files in the directories. If left
685 # blank all files are included.
685 # blank all files are included.
686
686
687 EXAMPLE_PATTERNS = *
687 EXAMPLE_PATTERNS = *
688
688
689 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
689 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
690 # searched for input files to be used with the \include or \dontinclude
690 # searched for input files to be used with the \include or \dontinclude
691 # commands irrespective of the value of the RECURSIVE tag.
691 # commands irrespective of the value of the RECURSIVE tag.
692 # Possible values are YES and NO. If left blank NO is used.
692 # Possible values are YES and NO. If left blank NO is used.
693
693
694 EXAMPLE_RECURSIVE = NO
694 EXAMPLE_RECURSIVE = NO
695
695
696 # The IMAGE_PATH tag can be used to specify one or more files or
696 # The IMAGE_PATH tag can be used to specify one or more files or
697 # directories that contain image that are included in the documentation (see
697 # directories that contain image that are included in the documentation (see
698 # the \image command).
698 # the \image command).
699
699
700 IMAGE_PATH =
700 IMAGE_PATH =
701
701
702 # The INPUT_FILTER tag can be used to specify a program that doxygen should
702 # The INPUT_FILTER tag can be used to specify a program that doxygen should
703 # invoke to filter for each input file. Doxygen will invoke the filter program
703 # invoke to filter for each input file. Doxygen will invoke the filter program
704 # by executing (via popen()) the command <filter> <input-file>, where <filter>
704 # by executing (via popen()) the command <filter> <input-file>, where <filter>
705 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
705 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
706 # input file. Doxygen will then use the output that the filter program writes
706 # input file. Doxygen will then use the output that the filter program writes
707 # to standard output. If FILTER_PATTERNS is specified, this tag will be
707 # to standard output. If FILTER_PATTERNS is specified, this tag will be
708 # ignored.
708 # ignored.
709
709
710 INPUT_FILTER =
710 INPUT_FILTER =
711
711
712 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
712 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
713 # basis. Doxygen will compare the file name with each pattern and apply the
713 # basis. Doxygen will compare the file name with each pattern and apply the
714 # filter if there is a match. The filters are a list of the form:
714 # filter if there is a match. The filters are a list of the form:
715 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
715 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
716 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
716 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
717 # is applied to all files.
717 # is applied to all files.
718
718
719 FILTER_PATTERNS =
719 FILTER_PATTERNS =
720
720
721 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
721 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
722 # INPUT_FILTER) will be used to filter the input files when producing source
722 # INPUT_FILTER) will be used to filter the input files when producing source
723 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
723 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
724
724
725 FILTER_SOURCE_FILES = NO
725 FILTER_SOURCE_FILES = NO
726
726
727 #---------------------------------------------------------------------------
727 #---------------------------------------------------------------------------
728 # configuration options related to source browsing
728 # configuration options related to source browsing
729 #---------------------------------------------------------------------------
729 #---------------------------------------------------------------------------
730
730
731 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
731 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
732 # be generated. Documented entities will be cross-referenced with these sources.
732 # be generated. Documented entities will be cross-referenced with these sources.
733 # Note: To get rid of all source code in the generated output, make sure also
733 # Note: To get rid of all source code in the generated output, make sure also
734 # VERBATIM_HEADERS is set to NO.
734 # VERBATIM_HEADERS is set to NO.
735
735
736 SOURCE_BROWSER = NO
736 SOURCE_BROWSER = NO
737
737
738 # Setting the INLINE_SOURCES tag to YES will include the body
738 # Setting the INLINE_SOURCES tag to YES will include the body
739 # of functions and classes directly in the documentation.
739 # of functions and classes directly in the documentation.
740
740
741 INLINE_SOURCES = NO
741 INLINE_SOURCES = NO
742
742
743 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
743 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
744 # doxygen to hide any special comment blocks from generated source code
744 # doxygen to hide any special comment blocks from generated source code
745 # fragments. Normal C and C++ comments will always remain visible.
745 # fragments. Normal C and C++ comments will always remain visible.
746
746
747 STRIP_CODE_COMMENTS = YES
747 STRIP_CODE_COMMENTS = YES
748
748
749 # If the REFERENCED_BY_RELATION tag is set to YES
749 # If the REFERENCED_BY_RELATION tag is set to YES
750 # then for each documented function all documented
750 # then for each documented function all documented
751 # functions referencing it will be listed.
751 # functions referencing it will be listed.
752
752
753 REFERENCED_BY_RELATION = NO
753 REFERENCED_BY_RELATION = NO
754
754
755 # If the REFERENCES_RELATION tag is set to YES
755 # If the REFERENCES_RELATION tag is set to YES
756 # then for each documented function all documented entities
756 # then for each documented function all documented entities
757 # called/used by that function will be listed.
757 # called/used by that function will be listed.
758
758
759 REFERENCES_RELATION = NO
759 REFERENCES_RELATION = NO
760
760
761 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
761 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
762 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
762 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
763 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
763 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
764 # link to the source code. Otherwise they will link to the documentation.
764 # link to the source code. Otherwise they will link to the documentation.
765
765
766 REFERENCES_LINK_SOURCE = YES
766 REFERENCES_LINK_SOURCE = YES
767
767
768 # If the USE_HTAGS tag is set to YES then the references to source code
768 # If the USE_HTAGS tag is set to YES then the references to source code
769 # will point to the HTML generated by the htags(1) tool instead of doxygen
769 # will point to the HTML generated by the htags(1) tool instead of doxygen
770 # built-in source browser. The htags tool is part of GNU's global source
770 # built-in source browser. The htags tool is part of GNU's global source
771 # tagging system (see http://www.gnu.org/software/global/global.html). You
771 # tagging system (see http://www.gnu.org/software/global/global.html). You
772 # will need version 4.8.6 or higher.
772 # will need version 4.8.6 or higher.
773
773
774 USE_HTAGS = NO
774 USE_HTAGS = NO
775
775
776 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
776 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
777 # will generate a verbatim copy of the header file for each class for
777 # will generate a verbatim copy of the header file for each class for
778 # which an include is specified. Set to NO to disable this.
778 # which an include is specified. Set to NO to disable this.
779
779
780 VERBATIM_HEADERS = YES
780 VERBATIM_HEADERS = YES
781
781
782 #---------------------------------------------------------------------------
782 #---------------------------------------------------------------------------
783 # configuration options related to the alphabetical class index
783 # configuration options related to the alphabetical class index
784 #---------------------------------------------------------------------------
784 #---------------------------------------------------------------------------
785
785
786 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
786 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
787 # of all compounds will be generated. Enable this if the project
787 # of all compounds will be generated. Enable this if the project
788 # contains a lot of classes, structs, unions or interfaces.
788 # contains a lot of classes, structs, unions or interfaces.
789
789
790 ALPHABETICAL_INDEX = YES
790 ALPHABETICAL_INDEX = YES
791
791
792 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
792 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
793 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
793 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
794 # in which this list will be split (can be a number in the range [1..20])
794 # in which this list will be split (can be a number in the range [1..20])
795
795
796 COLS_IN_ALPHA_INDEX = 5
796 COLS_IN_ALPHA_INDEX = 5
797
797
798 # In case all classes in a project start with a common prefix, all
798 # In case all classes in a project start with a common prefix, all
799 # classes will be put under the same header in the alphabetical index.
799 # classes will be put under the same header in the alphabetical index.
800 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
800 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
801 # should be ignored while generating the index headers.
801 # should be ignored while generating the index headers.
802
802
803 IGNORE_PREFIX =
803 IGNORE_PREFIX =
804
804
805 #---------------------------------------------------------------------------
805 #---------------------------------------------------------------------------
806 # configuration options related to the HTML output
806 # configuration options related to the HTML output
807 #---------------------------------------------------------------------------
807 #---------------------------------------------------------------------------
808
808
809 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
809 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
810 # generate HTML output.
810 # generate HTML output.
811
811
812 GENERATE_HTML = YES
812 GENERATE_HTML = YES
813
813
814 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
814 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
815 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
815 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
816 # put in front of it. If left blank `html' will be used as the default path.
816 # put in front of it. If left blank `html' will be used as the default path.
817
817
818 HTML_OUTPUT = html
818 HTML_OUTPUT = html
819
819
820 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
820 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
821 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
821 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
822 # doxygen will generate files with .html extension.
822 # doxygen will generate files with .html extension.
823
823
824 HTML_FILE_EXTENSION = .html
824 HTML_FILE_EXTENSION = .html
825
825
826 # The HTML_HEADER tag can be used to specify a personal HTML header for
826 # The HTML_HEADER tag can be used to specify a personal HTML header for
827 # each generated HTML page. If it is left blank doxygen will generate a
827 # each generated HTML page. If it is left blank doxygen will generate a
828 # standard header.
828 # standard header.
829
829
830 HTML_HEADER =
830 HTML_HEADER =
831
831
832 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
832 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
833 # each generated HTML page. If it is left blank doxygen will generate a
833 # each generated HTML page. If it is left blank doxygen will generate a
834 # standard footer.
834 # standard footer.
835
835
836 HTML_FOOTER =
836 HTML_FOOTER =
837
837
838 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
838 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
839 # style sheet that is used by each HTML page. It can be used to
839 # style sheet that is used by each HTML page. It can be used to
840 # fine-tune the look of the HTML output. If the tag is left blank doxygen
840 # fine-tune the look of the HTML output. If the tag is left blank doxygen
841 # will generate a default style sheet. Note that doxygen will try to copy
841 # will generate a default style sheet. Note that doxygen will try to copy
842 # the style sheet file to the HTML output directory, so don't put your own
842 # the style sheet file to the HTML output directory, so don't put your own
843 # stylesheet in the HTML output directory as well, or it will be erased!
843 # stylesheet in the HTML output directory as well, or it will be erased!
844
844
845 HTML_STYLESHEET =
845 HTML_STYLESHEET =
846
846
847 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
847 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
848 # Doxygen will adjust the colors in the stylesheet and background images
848 # Doxygen will adjust the colors in the stylesheet and background images
849 # according to this color. Hue is specified as an angle on a colorwheel,
849 # according to this color. Hue is specified as an angle on a colorwheel,
850 # see http://en.wikipedia.org/wiki/Hue for more information.
850 # see http://en.wikipedia.org/wiki/Hue for more information.
851 # For instance the value 0 represents red, 60 is yellow, 120 is green,
851 # For instance the value 0 represents red, 60 is yellow, 120 is green,
852 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
852 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
853 # The allowed range is 0 to 359.
853 # The allowed range is 0 to 359.
854
854
855 HTML_COLORSTYLE_HUE = 220
855 HTML_COLORSTYLE_HUE = 220
856
856
857 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
857 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
858 # the colors in the HTML output. For a value of 0 the output will use
858 # the colors in the HTML output. For a value of 0 the output will use
859 # grayscales only. A value of 255 will produce the most vivid colors.
859 # grayscales only. A value of 255 will produce the most vivid colors.
860
860
861 HTML_COLORSTYLE_SAT = 100
861 HTML_COLORSTYLE_SAT = 100
862
862
863 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
863 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
864 # the luminance component of the colors in the HTML output. Values below
864 # the luminance component of the colors in the HTML output. Values below
865 # 100 gradually make the output lighter, whereas values above 100 make
865 # 100 gradually make the output lighter, whereas values above 100 make
866 # the output darker. The value divided by 100 is the actual gamma applied,
866 # the output darker. The value divided by 100 is the actual gamma applied,
867 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
867 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
868 # and 100 does not change the gamma.
868 # and 100 does not change the gamma.
869
869
870 HTML_COLORSTYLE_GAMMA = 80
870 HTML_COLORSTYLE_GAMMA = 80
871
871
872 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
872 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
873 # page will contain the date and time when the page was generated. Setting
873 # page will contain the date and time when the page was generated. Setting
874 # this to NO can help when comparing the output of multiple runs.
874 # this to NO can help when comparing the output of multiple runs.
875
875
876 HTML_TIMESTAMP = YES
876 HTML_TIMESTAMP = YES
877
877
878 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
878 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
879 # files or namespaces will be aligned in HTML using tables. If set to
879 # files or namespaces will be aligned in HTML using tables. If set to
880 # NO a bullet list will be used.
880 # NO a bullet list will be used.
881
881
882 HTML_ALIGN_MEMBERS = YES
882 HTML_ALIGN_MEMBERS = YES
883
883
884 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
884 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
885 # documentation will contain sections that can be hidden and shown after the
885 # documentation will contain sections that can be hidden and shown after the
886 # page has loaded. For this to work a browser that supports
886 # page has loaded. For this to work a browser that supports
887 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
887 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
888 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
888 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
889
889
890 HTML_DYNAMIC_SECTIONS = NO
890 HTML_DYNAMIC_SECTIONS = NO
891
891
892 # If the GENERATE_DOCSET tag is set to YES, additional index files
892 # If the GENERATE_DOCSET tag is set to YES, additional index files
893 # will be generated that can be used as input for Apple's Xcode 3
893 # will be generated that can be used as input for Apple's Xcode 3
894 # integrated development environment, introduced with OSX 10.5 (Leopard).
894 # integrated development environment, introduced with OSX 10.5 (Leopard).
895 # To create a documentation set, doxygen will generate a Makefile in the
895 # To create a documentation set, doxygen will generate a Makefile in the
896 # HTML output directory. Running make will produce the docset in that
896 # HTML output directory. Running make will produce the docset in that
897 # directory and running "make install" will install the docset in
897 # directory and running "make install" will install the docset in
898 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
898 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
899 # it at startup.
899 # it at startup.
900 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
900 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
901 # for more information.
901 # for more information.
902
902
903 GENERATE_DOCSET = NO
903 GENERATE_DOCSET = NO
904
904
905 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
905 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
906 # feed. A documentation feed provides an umbrella under which multiple
906 # feed. A documentation feed provides an umbrella under which multiple
907 # documentation sets from a single provider (such as a company or product suite)
907 # documentation sets from a single provider (such as a company or product suite)
908 # can be grouped.
908 # can be grouped.
909
909
910 DOCSET_FEEDNAME = "Doxygen generated docs"
910 DOCSET_FEEDNAME = "Doxygen generated docs"
911
911
912 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
912 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
913 # should uniquely identify the documentation set bundle. This should be a
913 # should uniquely identify the documentation set bundle. This should be a
914 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
914 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
915 # will append .docset to the name.
915 # will append .docset to the name.
916
916
917 DOCSET_BUNDLE_ID = org.doxygen.Project
917 DOCSET_BUNDLE_ID = org.doxygen.Project
918
918
919 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
919 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
920 # the documentation publisher. This should be a reverse domain-name style
920 # the documentation publisher. This should be a reverse domain-name style
921 # string, e.g. com.mycompany.MyDocSet.documentation.
921 # string, e.g. com.mycompany.MyDocSet.documentation.
922
922
923 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
923 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
924
924
925 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
925 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
926
926
927 DOCSET_PUBLISHER_NAME = Publisher
927 DOCSET_PUBLISHER_NAME = Publisher
928
928
929 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
929 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
930 # will be generated that can be used as input for tools like the
930 # will be generated that can be used as input for tools like the
931 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
931 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
932 # of the generated HTML documentation.
932 # of the generated HTML documentation.
933
933
934 GENERATE_HTMLHELP = NO
934 GENERATE_HTMLHELP = NO
935
935
936 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
936 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
937 # be used to specify the file name of the resulting .chm file. You
937 # be used to specify the file name of the resulting .chm file. You
938 # can add a path in front of the file if the result should not be
938 # can add a path in front of the file if the result should not be
939 # written to the html output directory.
939 # written to the html output directory.
940
940
941 CHM_FILE =
941 CHM_FILE =
942
942
943 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
943 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
944 # be used to specify the location (absolute path including file name) of
944 # be used to specify the location (absolute path including file name) of
945 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
945 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
946 # the HTML help compiler on the generated index.hhp.
946 # the HTML help compiler on the generated index.hhp.
947
947
948 HHC_LOCATION =
948 HHC_LOCATION =
949
949
950 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
950 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
951 # controls if a separate .chi index file is generated (YES) or that
951 # controls if a separate .chi index file is generated (YES) or that
952 # it should be included in the master .chm file (NO).
952 # it should be included in the master .chm file (NO).
953
953
954 GENERATE_CHI = NO
954 GENERATE_CHI = NO
955
955
956 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
956 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
957 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
957 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
958 # content.
958 # content.
959
959
960 CHM_INDEX_ENCODING =
960 CHM_INDEX_ENCODING =
961
961
962 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
962 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
963 # controls whether a binary table of contents is generated (YES) or a
963 # controls whether a binary table of contents is generated (YES) or a
964 # normal table of contents (NO) in the .chm file.
964 # normal table of contents (NO) in the .chm file.
965
965
966 BINARY_TOC = NO
966 BINARY_TOC = NO
967
967
968 # The TOC_EXPAND flag can be set to YES to add extra items for group members
968 # The TOC_EXPAND flag can be set to YES to add extra items for group members
969 # to the contents of the HTML help documentation and to the tree view.
969 # to the contents of the HTML help documentation and to the tree view.
970
970
971 TOC_EXPAND = NO
971 TOC_EXPAND = NO
972
972
973 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
973 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
974 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
974 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
975 # that can be used as input for Qt's qhelpgenerator to generate a
975 # that can be used as input for Qt's qhelpgenerator to generate a
976 # Qt Compressed Help (.qch) of the generated HTML documentation.
976 # Qt Compressed Help (.qch) of the generated HTML documentation.
977
977
978 GENERATE_QHP = NO
978 GENERATE_QHP = NO
979
979
980 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
980 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
981 # be used to specify the file name of the resulting .qch file.
981 # be used to specify the file name of the resulting .qch file.
982 # The path specified is relative to the HTML output folder.
982 # The path specified is relative to the HTML output folder.
983
983
984 QCH_FILE =
984 QCH_FILE =
985
985
986 # The QHP_NAMESPACE tag specifies the namespace to use when generating
986 # The QHP_NAMESPACE tag specifies the namespace to use when generating
987 # Qt Help Project output. For more information please see
987 # Qt Help Project output. For more information please see
988 # http://doc.trolltech.com/qthelpproject.html#namespace
988 # http://doc.trolltech.com/qthelpproject.html#namespace
989
989
990 QHP_NAMESPACE = org.doxygen.Project
990 QHP_NAMESPACE = org.doxygen.Project
991
991
992 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
992 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
993 # Qt Help Project output. For more information please see
993 # Qt Help Project output. For more information please see
994 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
994 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
995
995
996 QHP_VIRTUAL_FOLDER = doc
996 QHP_VIRTUAL_FOLDER = doc
997
997
998 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
998 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
999 # add. For more information please see
999 # add. For more information please see
1000 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1000 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1001
1001
1002 QHP_CUST_FILTER_NAME =
1002 QHP_CUST_FILTER_NAME =
1003
1003
1004 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1004 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1005 # custom filter to add. For more information please see
1005 # custom filter to add. For more information please see
1006 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1006 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1007 # Qt Help Project / Custom Filters</a>.
1007 # Qt Help Project / Custom Filters</a>.
1008
1008
1009 QHP_CUST_FILTER_ATTRS =
1009 QHP_CUST_FILTER_ATTRS =
1010
1010
1011 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1011 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1012 # project's
1012 # project's
1013 # filter section matches.
1013 # filter section matches.
1014 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1014 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1015 # Qt Help Project / Filter Attributes</a>.
1015 # Qt Help Project / Filter Attributes</a>.
1016
1016
1017 QHP_SECT_FILTER_ATTRS =
1017 QHP_SECT_FILTER_ATTRS =
1018
1018
1019 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1019 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1020 # be used to specify the location of Qt's qhelpgenerator.
1020 # be used to specify the location of Qt's qhelpgenerator.
1021 # If non-empty doxygen will try to run qhelpgenerator on the generated
1021 # If non-empty doxygen will try to run qhelpgenerator on the generated
1022 # .qhp file.
1022 # .qhp file.
1023
1023
1024 QHG_LOCATION =
1024 QHG_LOCATION =
1025
1025
1026 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1026 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1027 # will be generated, which together with the HTML files, form an Eclipse help
1027 # will be generated, which together with the HTML files, form an Eclipse help
1028 # plugin. To install this plugin and make it available under the help contents
1028 # plugin. To install this plugin and make it available under the help contents
1029 # menu in Eclipse, the contents of the directory containing the HTML and XML
1029 # menu in Eclipse, the contents of the directory containing the HTML and XML
1030 # files needs to be copied into the plugins directory of eclipse. The name of
1030 # files needs to be copied into the plugins directory of eclipse. The name of
1031 # the directory within the plugins directory should be the same as
1031 # the directory within the plugins directory should be the same as
1032 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1032 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1033 # the help appears.
1033 # the help appears.
1034
1034
1035 GENERATE_ECLIPSEHELP = NO
1035 GENERATE_ECLIPSEHELP = NO
1036
1036
1037 # A unique identifier for the eclipse help plugin. When installing the plugin
1037 # A unique identifier for the eclipse help plugin. When installing the plugin
1038 # the directory name containing the HTML and XML files should also have
1038 # the directory name containing the HTML and XML files should also have
1039 # this name.
1039 # this name.
1040
1040
1041 ECLIPSE_DOC_ID = org.doxygen.Project
1041 ECLIPSE_DOC_ID = org.doxygen.Project
1042
1042
1043 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1043 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1044 # top of each HTML page. The value NO (the default) enables the index and
1044 # top of each HTML page. The value NO (the default) enables the index and
1045 # the value YES disables it.
1045 # the value YES disables it.
1046
1046
1047 DISABLE_INDEX = NO
1047 DISABLE_INDEX = NO
1048
1048
1049 # This tag can be used to set the number of enum values (range [1..20])
1049 # This tag can be used to set the number of enum values (range [1..20])
1050 # that doxygen will group on one line in the generated HTML documentation.
1050 # that doxygen will group on one line in the generated HTML documentation.
1051
1051
1052 ENUM_VALUES_PER_LINE = 4
1052 ENUM_VALUES_PER_LINE = 4
1053
1053
1054 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1054 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1055 # structure should be generated to display hierarchical information.
1055 # structure should be generated to display hierarchical information.
1056 # If the tag value is set to YES, a side panel will be generated
1056 # If the tag value is set to YES, a side panel will be generated
1057 # containing a tree-like index structure (just like the one that
1057 # containing a tree-like index structure (just like the one that
1058 # is generated for HTML Help). For this to work a browser that supports
1058 # is generated for HTML Help). For this to work a browser that supports
1059 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1059 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1060 # Windows users are probably better off using the HTML help feature.
1060 # Windows users are probably better off using the HTML help feature.
1061
1061
1062 GENERATE_TREEVIEW = NO
1062 GENERATE_TREEVIEW = NO
1063
1063
1064 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1064 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1065 # and Class Hierarchy pages using a tree view instead of an ordered list.
1065 # and Class Hierarchy pages using a tree view instead of an ordered list.
1066
1066
1067 USE_INLINE_TREES = NO
1067 USE_INLINE_TREES = NO
1068
1068
1069 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1069 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1070 # used to set the initial width (in pixels) of the frame in which the tree
1070 # used to set the initial width (in pixels) of the frame in which the tree
1071 # is shown.
1071 # is shown.
1072
1072
1073 TREEVIEW_WIDTH = 250
1073 TREEVIEW_WIDTH = 250
1074
1074
1075 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1075 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1076 # links to external symbols imported via tag files in a separate window.
1076 # links to external symbols imported via tag files in a separate window.
1077
1077
1078 EXT_LINKS_IN_WINDOW = NO
1078 EXT_LINKS_IN_WINDOW = NO
1079
1079
1080 # Use this tag to change the font size of Latex formulas included
1080 # Use this tag to change the font size of Latex formulas included
1081 # as images in the HTML documentation. The default is 10. Note that
1081 # as images in the HTML documentation. The default is 10. Note that
1082 # when you change the font size after a successful doxygen run you need
1082 # when you change the font size after a successful doxygen run you need
1083 # to manually remove any form_*.png images from the HTML output directory
1083 # to manually remove any form_*.png images from the HTML output directory
1084 # to force them to be regenerated.
1084 # to force them to be regenerated.
1085
1085
1086 FORMULA_FONTSIZE = 10
1086 FORMULA_FONTSIZE = 10
1087
1087
1088 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1088 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1089 # generated for formulas are transparent PNGs. Transparent PNGs are
1089 # generated for formulas are transparent PNGs. Transparent PNGs are
1090 # not supported properly for IE 6.0, but are supported on all modern browsers.
1090 # not supported properly for IE 6.0, but are supported on all modern browsers.
1091 # Note that when changing this option you need to delete any form_*.png files
1091 # Note that when changing this option you need to delete any form_*.png files
1092 # in the HTML output before the changes have effect.
1092 # in the HTML output before the changes have effect.
1093
1093
1094 FORMULA_TRANSPARENT = YES
1094 FORMULA_TRANSPARENT = YES
1095
1095
1096 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1096 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1097 # for the HTML output. The underlying search engine uses javascript
1097 # for the HTML output. The underlying search engine uses javascript
1098 # and DHTML and should work on any modern browser. Note that when using
1098 # and DHTML and should work on any modern browser. Note that when using
1099 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1099 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1100 # (GENERATE_DOCSET) there is already a search function so this one should
1100 # (GENERATE_DOCSET) there is already a search function so this one should
1101 # typically be disabled. For large projects the javascript based search engine
1101 # typically be disabled. For large projects the javascript based search engine
1102 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1102 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1103
1103
1104 SEARCHENGINE = YES
1104 SEARCHENGINE = YES
1105
1105
1106 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1106 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1107 # implemented using a PHP enabled web server instead of at the web client
1107 # implemented using a PHP enabled web server instead of at the web client
1108 # using Javascript. Doxygen will generate the search PHP script and index
1108 # using Javascript. Doxygen will generate the search PHP script and index
1109 # file to put on the web server. The advantage of the server
1109 # file to put on the web server. The advantage of the server
1110 # based approach is that it scales better to large projects and allows
1110 # based approach is that it scales better to large projects and allows
1111 # full text search. The disadvances is that it is more difficult to setup
1111 # full text search. The disadvances is that it is more difficult to setup
1112 # and does not have live searching capabilities.
1112 # and does not have live searching capabilities.
1113
1113
1114 SERVER_BASED_SEARCH = NO
1114 SERVER_BASED_SEARCH = NO
1115
1115
1116 #---------------------------------------------------------------------------
1116 #---------------------------------------------------------------------------
1117 # configuration options related to the LaTeX output
1117 # configuration options related to the LaTeX output
1118 #---------------------------------------------------------------------------
1118 #---------------------------------------------------------------------------
1119
1119
1120 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1120 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1121 # generate Latex output.
1121 # generate Latex output.
1122
1122
1123 GENERATE_LATEX = YES
1123 GENERATE_LATEX = YES
1124
1124
1125 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1125 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1126 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1126 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1127 # put in front of it. If left blank `latex' will be used as the default path.
1127 # put in front of it. If left blank `latex' will be used as the default path.
1128
1128
1129 LATEX_OUTPUT = latex
1129 LATEX_OUTPUT = latex
1130
1130
1131 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1131 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1132 # invoked. If left blank `latex' will be used as the default command name.
1132 # invoked. If left blank `latex' will be used as the default command name.
1133 # Note that when enabling USE_PDFLATEX this option is only used for
1133 # Note that when enabling USE_PDFLATEX this option is only used for
1134 # generating bitmaps for formulas in the HTML output, but not in the
1134 # generating bitmaps for formulas in the HTML output, but not in the
1135 # Makefile that is written to the output directory.
1135 # Makefile that is written to the output directory.
1136
1136
1137 LATEX_CMD_NAME = latex
1137 LATEX_CMD_NAME = latex
1138
1138
1139 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1139 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1140 # generate index for LaTeX. If left blank `makeindex' will be used as the
1140 # generate index for LaTeX. If left blank `makeindex' will be used as the
1141 # default command name.
1141 # default command name.
1142
1142
1143 MAKEINDEX_CMD_NAME = makeindex
1143 MAKEINDEX_CMD_NAME = makeindex
1144
1144
1145 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1145 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1146 # LaTeX documents. This may be useful for small projects and may help to
1146 # LaTeX documents. This may be useful for small projects and may help to
1147 # save some trees in general.
1147 # save some trees in general.
1148
1148
1149 COMPACT_LATEX = NO
1149 COMPACT_LATEX = NO
1150
1150
1151 # The PAPER_TYPE tag can be used to set the paper type that is used
1151 # The PAPER_TYPE tag can be used to set the paper type that is used
1152 # by the printer. Possible values are: a4, a4wide, letter, legal and
1152 # by the printer. Possible values are: a4, a4wide, letter, legal and
1153 # executive. If left blank a4wide will be used.
1153 # executive. If left blank a4wide will be used.
1154
1154
1155 PAPER_TYPE = a4wide
1155 PAPER_TYPE = a4wide
1156
1156
1157 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1157 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1158 # packages that should be included in the LaTeX output.
1158 # packages that should be included in the LaTeX output.
1159
1159
1160 EXTRA_PACKAGES =
1160 EXTRA_PACKAGES =
1161
1161
1162 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1162 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1163 # the generated latex document. The header should contain everything until
1163 # the generated latex document. The header should contain everything until
1164 # the first chapter. If it is left blank doxygen will generate a
1164 # the first chapter. If it is left blank doxygen will generate a
1165 # standard header. Notice: only use this tag if you know what you are doing!
1165 # standard header. Notice: only use this tag if you know what you are doing!
1166
1166
1167 LATEX_HEADER =
1167 LATEX_HEADER =
1168
1168
1169 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1169 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1170 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1170 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1171 # contain links (just like the HTML output) instead of page references
1171 # contain links (just like the HTML output) instead of page references
1172 # This makes the output suitable for online browsing using a pdf viewer.
1172 # This makes the output suitable for online browsing using a pdf viewer.
1173
1173
1174 PDF_HYPERLINKS = YES
1174 PDF_HYPERLINKS = YES
1175
1175
1176 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1176 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1177 # plain latex in the generated Makefile. Set this option to YES to get a
1177 # plain latex in the generated Makefile. Set this option to YES to get a
1178 # higher quality PDF documentation.
1178 # higher quality PDF documentation.
1179
1179
1180 USE_PDFLATEX = YES
1180 USE_PDFLATEX = YES
1181
1181
1182 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1182 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1183 # command to the generated LaTeX files. This will instruct LaTeX to keep
1183 # command to the generated LaTeX files. This will instruct LaTeX to keep
1184 # running if errors occur, instead of asking the user for help.
1184 # running if errors occur, instead of asking the user for help.
1185 # This option is also used when generating formulas in HTML.
1185 # This option is also used when generating formulas in HTML.
1186
1186
1187 LATEX_BATCHMODE = NO
1187 LATEX_BATCHMODE = NO
1188
1188
1189 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1189 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1190 # include the index chapters (such as File Index, Compound Index, etc.)
1190 # include the index chapters (such as File Index, Compound Index, etc.)
1191 # in the output.
1191 # in the output.
1192
1192
1193 LATEX_HIDE_INDICES = NO
1193 LATEX_HIDE_INDICES = NO
1194
1194
1195 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1195 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1196 # source code with syntax highlighting in the LaTeX output.
1196 # source code with syntax highlighting in the LaTeX output.
1197 # Note that which sources are shown also depends on other settings
1197 # Note that which sources are shown also depends on other settings
1198 # such as SOURCE_BROWSER.
1198 # such as SOURCE_BROWSER.
1199
1199
1200 LATEX_SOURCE_CODE = NO
1200 LATEX_SOURCE_CODE = NO
1201
1201
1202 #---------------------------------------------------------------------------
1202 #---------------------------------------------------------------------------
1203 # configuration options related to the RTF output
1203 # configuration options related to the RTF output
1204 #---------------------------------------------------------------------------
1204 #---------------------------------------------------------------------------
1205
1205
1206 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1206 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1207 # The RTF output is optimized for Word 97 and may not look very pretty with
1207 # The RTF output is optimized for Word 97 and may not look very pretty with
1208 # other RTF readers or editors.
1208 # other RTF readers or editors.
1209
1209
1210 GENERATE_RTF = NO
1210 GENERATE_RTF = NO
1211
1211
1212 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1212 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1213 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1213 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1214 # put in front of it. If left blank `rtf' will be used as the default path.
1214 # put in front of it. If left blank `rtf' will be used as the default path.
1215
1215
1216 RTF_OUTPUT = rtf
1216 RTF_OUTPUT = rtf
1217
1217
1218 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1218 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1219 # RTF documents. This may be useful for small projects and may help to
1219 # RTF documents. This may be useful for small projects and may help to
1220 # save some trees in general.
1220 # save some trees in general.
1221
1221
1222 COMPACT_RTF = NO
1222 COMPACT_RTF = NO
1223
1223
1224 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1224 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1225 # will contain hyperlink fields. The RTF file will
1225 # will contain hyperlink fields. The RTF file will
1226 # contain links (just like the HTML output) instead of page references.
1226 # contain links (just like the HTML output) instead of page references.
1227 # This makes the output suitable for online browsing using WORD or other
1227 # This makes the output suitable for online browsing using WORD or other
1228 # programs which support those fields.
1228 # programs which support those fields.
1229 # Note: wordpad (write) and others do not support links.
1229 # Note: wordpad (write) and others do not support links.
1230
1230
1231 RTF_HYPERLINKS = NO
1231 RTF_HYPERLINKS = NO
1232
1232
1233 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1233 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1234 # config file, i.e. a series of assignments. You only have to provide
1234 # config file, i.e. a series of assignments. You only have to provide
1235 # replacements, missing definitions are set to their default value.
1235 # replacements, missing definitions are set to their default value.
1236
1236
1237 RTF_STYLESHEET_FILE =
1237 RTF_STYLESHEET_FILE =
1238
1238
1239 # Set optional variables used in the generation of an rtf document.
1239 # Set optional variables used in the generation of an rtf document.
1240 # Syntax is similar to doxygen's config file.
1240 # Syntax is similar to doxygen's config file.
1241
1241
1242 RTF_EXTENSIONS_FILE =
1242 RTF_EXTENSIONS_FILE =
1243
1243
1244 #---------------------------------------------------------------------------
1244 #---------------------------------------------------------------------------
1245 # configuration options related to the man page output
1245 # configuration options related to the man page output
1246 #---------------------------------------------------------------------------
1246 #---------------------------------------------------------------------------
1247
1247
1248 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1248 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1249 # generate man pages
1249 # generate man pages
1250
1250
1251 GENERATE_MAN = NO
1251 GENERATE_MAN = YES
1252
1252
1253 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1253 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1254 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1254 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1255 # put in front of it. If left blank `man' will be used as the default path.
1255 # put in front of it. If left blank `man' will be used as the default path.
1256
1256
1257 MAN_OUTPUT = man
1257 MAN_OUTPUT = man
1258
1258
1259 # The MAN_EXTENSION tag determines the extension that is added to
1259 # The MAN_EXTENSION tag determines the extension that is added to
1260 # the generated man pages (default is the subroutine's section .3)
1260 # the generated man pages (default is the subroutine's section .3)
1261
1261
1262 MAN_EXTENSION = .3
1262 MAN_EXTENSION = .3
1263
1263
1264 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1264 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1265 # then it will generate one additional man file for each entity
1265 # then it will generate one additional man file for each entity
1266 # documented in the real man page(s). These additional files
1266 # documented in the real man page(s). These additional files
1267 # only source the real man page, but without them the man command
1267 # only source the real man page, but without them the man command
1268 # would be unable to find the correct page. The default is NO.
1268 # would be unable to find the correct page. The default is NO.
1269
1269
1270 MAN_LINKS = NO
1270 MAN_LINKS = NO
1271
1271
1272 #---------------------------------------------------------------------------
1272 #---------------------------------------------------------------------------
1273 # configuration options related to the XML output
1273 # configuration options related to the XML output
1274 #---------------------------------------------------------------------------
1274 #---------------------------------------------------------------------------
1275
1275
1276 # If the GENERATE_XML tag is set to YES Doxygen will
1276 # If the GENERATE_XML tag is set to YES Doxygen will
1277 # generate an XML file that captures the structure of
1277 # generate an XML file that captures the structure of
1278 # the code including all documentation.
1278 # the code including all documentation.
1279
1279
1280 GENERATE_XML = NO
1280 GENERATE_XML = NO
1281
1281
1282 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1282 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1283 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1283 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1284 # put in front of it. If left blank `xml' will be used as the default path.
1284 # put in front of it. If left blank `xml' will be used as the default path.
1285
1285
1286 XML_OUTPUT = xml
1286 XML_OUTPUT = xml
1287
1287
1288 # The XML_SCHEMA tag can be used to specify an XML schema,
1288 # The XML_SCHEMA tag can be used to specify an XML schema,
1289 # which can be used by a validating XML parser to check the
1289 # which can be used by a validating XML parser to check the
1290 # syntax of the XML files.
1290 # syntax of the XML files.
1291
1291
1292 XML_SCHEMA =
1292 XML_SCHEMA =
1293
1293
1294 # The XML_DTD tag can be used to specify an XML DTD,
1294 # The XML_DTD tag can be used to specify an XML DTD,
1295 # which can be used by a validating XML parser to check the
1295 # which can be used by a validating XML parser to check the
1296 # syntax of the XML files.
1296 # syntax of the XML files.
1297
1297
1298 XML_DTD =
1298 XML_DTD =
1299
1299
1300 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1300 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1301 # dump the program listings (including syntax highlighting
1301 # dump the program listings (including syntax highlighting
1302 # and cross-referencing information) to the XML output. Note that
1302 # and cross-referencing information) to the XML output. Note that
1303 # enabling this will significantly increase the size of the XML output.
1303 # enabling this will significantly increase the size of the XML output.
1304
1304
1305 XML_PROGRAMLISTING = YES
1305 XML_PROGRAMLISTING = YES
1306
1306
1307 #---------------------------------------------------------------------------
1307 #---------------------------------------------------------------------------
1308 # configuration options for the AutoGen Definitions output
1308 # configuration options for the AutoGen Definitions output
1309 #---------------------------------------------------------------------------
1309 #---------------------------------------------------------------------------
1310
1310
1311 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1311 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1312 # generate an AutoGen Definitions (see autogen.sf.net) file
1312 # generate an AutoGen Definitions (see autogen.sf.net) file
1313 # that captures the structure of the code including all
1313 # that captures the structure of the code including all
1314 # documentation. Note that this feature is still experimental
1314 # documentation. Note that this feature is still experimental
1315 # and incomplete at the moment.
1315 # and incomplete at the moment.
1316
1316
1317 GENERATE_AUTOGEN_DEF = NO
1317 GENERATE_AUTOGEN_DEF = NO
1318
1318
1319 #---------------------------------------------------------------------------
1319 #---------------------------------------------------------------------------
1320 # configuration options related to the Perl module output
1320 # configuration options related to the Perl module output
1321 #---------------------------------------------------------------------------
1321 #---------------------------------------------------------------------------
1322
1322
1323 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1323 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1324 # generate a Perl module file that captures the structure of
1324 # generate a Perl module file that captures the structure of
1325 # the code including all documentation. Note that this
1325 # the code including all documentation. Note that this
1326 # feature is still experimental and incomplete at the
1326 # feature is still experimental and incomplete at the
1327 # moment.
1327 # moment.
1328
1328
1329 GENERATE_PERLMOD = NO
1329 GENERATE_PERLMOD = NO
1330
1330
1331 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1331 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1332 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1332 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1333 # to generate PDF and DVI output from the Perl module output.
1333 # to generate PDF and DVI output from the Perl module output.
1334
1334
1335 PERLMOD_LATEX = NO
1335 PERLMOD_LATEX = NO
1336
1336
1337 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1337 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1338 # nicely formatted so it can be parsed by a human reader. This is useful
1338 # nicely formatted so it can be parsed by a human reader. This is useful
1339 # if you want to understand what is going on. On the other hand, if this
1339 # if you want to understand what is going on. On the other hand, if this
1340 # tag is set to NO the size of the Perl module output will be much smaller
1340 # tag is set to NO the size of the Perl module output will be much smaller
1341 # and Perl will parse it just the same.
1341 # and Perl will parse it just the same.
1342
1342
1343 PERLMOD_PRETTY = YES
1343 PERLMOD_PRETTY = YES
1344
1344
1345 # The names of the make variables in the generated doxyrules.make file
1345 # The names of the make variables in the generated doxyrules.make file
1346 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1346 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1347 # This is useful so different doxyrules.make files included by the same
1347 # This is useful so different doxyrules.make files included by the same
1348 # Makefile don't overwrite each other's variables.
1348 # Makefile don't overwrite each other's variables.
1349
1349
1350 PERLMOD_MAKEVAR_PREFIX =
1350 PERLMOD_MAKEVAR_PREFIX =
1351
1351
1352 #---------------------------------------------------------------------------
1352 #---------------------------------------------------------------------------
1353 # Configuration options related to the preprocessor
1353 # Configuration options related to the preprocessor
1354 #---------------------------------------------------------------------------
1354 #---------------------------------------------------------------------------
1355
1355
1356 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1356 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1357 # evaluate all C-preprocessor directives found in the sources and include
1357 # evaluate all C-preprocessor directives found in the sources and include
1358 # files.
1358 # files.
1359
1359
1360 ENABLE_PREPROCESSING = YES
1360 ENABLE_PREPROCESSING = YES
1361
1361
1362 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1362 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1363 # names in the source code. If set to NO (the default) only conditional
1363 # names in the source code. If set to NO (the default) only conditional
1364 # compilation will be performed. Macro expansion can be done in a controlled
1364 # compilation will be performed. Macro expansion can be done in a controlled
1365 # way by setting EXPAND_ONLY_PREDEF to YES.
1365 # way by setting EXPAND_ONLY_PREDEF to YES.
1366
1366
1367 MACRO_EXPANSION = NO
1367 MACRO_EXPANSION = NO
1368
1368
1369 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1369 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1370 # then the macro expansion is limited to the macros specified with the
1370 # then the macro expansion is limited to the macros specified with the
1371 # PREDEFINED and EXPAND_AS_DEFINED tags.
1371 # PREDEFINED and EXPAND_AS_DEFINED tags.
1372
1372
1373 EXPAND_ONLY_PREDEF = NO
1373 EXPAND_ONLY_PREDEF = NO
1374
1374
1375 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1375 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1376 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1376 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1377
1377
1378 SEARCH_INCLUDES = YES
1378 SEARCH_INCLUDES = YES
1379
1379
1380 # The INCLUDE_PATH tag can be used to specify one or more directories that
1380 # The INCLUDE_PATH tag can be used to specify one or more directories that
1381 # contain include files that are not input files but should be processed by
1381 # contain include files that are not input files but should be processed by
1382 # the preprocessor.
1382 # the preprocessor.
1383
1383
1384 INCLUDE_PATH =
1384 INCLUDE_PATH =
1385
1385
1386 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1386 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1387 # patterns (like *.h and *.hpp) to filter out the header-files in the
1387 # patterns (like *.h and *.hpp) to filter out the header-files in the
1388 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1388 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1389 # be used.
1389 # be used.
1390
1390
1391 INCLUDE_FILE_PATTERNS =
1391 INCLUDE_FILE_PATTERNS =
1392
1392
1393 # The PREDEFINED tag can be used to specify one or more macro names that
1393 # The PREDEFINED tag can be used to specify one or more macro names that
1394 # are defined before the preprocessor is started (similar to the -D option of
1394 # are defined before the preprocessor is started (similar to the -D option of
1395 # gcc). The argument of the tag is a list of macros of the form: name
1395 # gcc). The argument of the tag is a list of macros of the form: name
1396 # or name=definition (no spaces). If the definition and the = are
1396 # or name=definition (no spaces). If the definition and the = are
1397 # omitted =1 is assumed. To prevent a macro definition from being
1397 # omitted =1 is assumed. To prevent a macro definition from being
1398 # undefined via #undef or recursively expanded use the := operator
1398 # undefined via #undef or recursively expanded use the := operator
1399 # instead of the = operator.
1399 # instead of the = operator.
1400
1400
1401 PREDEFINED =
1401 PREDEFINED =
1402
1402
1403 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1403 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1404 # this tag can be used to specify a list of macro names that should be expanded.
1404 # this tag can be used to specify a list of macro names that should be expanded.
1405 # The macro definition that is found in the sources will be used.
1405 # The macro definition that is found in the sources will be used.
1406 # Use the PREDEFINED tag if you want to use a different macro definition.
1406 # Use the PREDEFINED tag if you want to use a different macro definition.
1407
1407
1408 EXPAND_AS_DEFINED =
1408 EXPAND_AS_DEFINED =
1409
1409
1410 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1410 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1411 # doxygen's preprocessor will remove all function-like macros that are alone
1411 # doxygen's preprocessor will remove all function-like macros that are alone
1412 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1412 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1413 # function macros are typically used for boiler-plate code, and will confuse
1413 # function macros are typically used for boiler-plate code, and will confuse
1414 # the parser if not removed.
1414 # the parser if not removed.
1415
1415
1416 SKIP_FUNCTION_MACROS = YES
1416 SKIP_FUNCTION_MACROS = YES
1417
1417
1418 #---------------------------------------------------------------------------
1418 #---------------------------------------------------------------------------
1419 # Configuration::additions related to external references
1419 # Configuration::additions related to external references
1420 #---------------------------------------------------------------------------
1420 #---------------------------------------------------------------------------
1421
1421
1422 # The TAGFILES option can be used to specify one or more tagfiles.
1422 # The TAGFILES option can be used to specify one or more tagfiles.
1423 # Optionally an initial location of the external documentation
1423 # Optionally an initial location of the external documentation
1424 # can be added for each tagfile. The format of a tag file without
1424 # can be added for each tagfile. The format of a tag file without
1425 # this location is as follows:
1425 # this location is as follows:
1426 # TAGFILES = file1 file2 ...
1426 # TAGFILES = file1 file2 ...
1427 # Adding location for the tag files is done as follows:
1427 # Adding location for the tag files is done as follows:
1428 # TAGFILES = file1=loc1 "file2 = loc2" ...
1428 # TAGFILES = file1=loc1 "file2 = loc2" ...
1429 # where "loc1" and "loc2" can be relative or absolute paths or
1429 # where "loc1" and "loc2" can be relative or absolute paths or
1430 # URLs. If a location is present for each tag, the installdox tool
1430 # URLs. If a location is present for each tag, the installdox tool
1431 # does not have to be run to correct the links.
1431 # does not have to be run to correct the links.
1432 # Note that each tag file must have a unique name
1432 # Note that each tag file must have a unique name
1433 # (where the name does NOT include the path)
1433 # (where the name does NOT include the path)
1434 # If a tag file is not located in the directory in which doxygen
1434 # If a tag file is not located in the directory in which doxygen
1435 # is run, you must also specify the path to the tagfile here.
1435 # is run, you must also specify the path to the tagfile here.
1436
1436
1437 TAGFILES =
1437 TAGFILES =
1438
1438
1439 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1439 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1440 # a tag file that is based on the input files it reads.
1440 # a tag file that is based on the input files it reads.
1441
1441
1442 GENERATE_TAGFILE =
1442 GENERATE_TAGFILE =
1443
1443
1444 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1444 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1445 # in the class index. If set to NO only the inherited external classes
1445 # in the class index. If set to NO only the inherited external classes
1446 # will be listed.
1446 # will be listed.
1447
1447
1448 ALLEXTERNALS = NO
1448 ALLEXTERNALS = NO
1449
1449
1450 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1450 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1451 # in the modules index. If set to NO, only the current project's groups will
1451 # in the modules index. If set to NO, only the current project's groups will
1452 # be listed.
1452 # be listed.
1453
1453
1454 EXTERNAL_GROUPS = YES
1454 EXTERNAL_GROUPS = YES
1455
1455
1456 # The PERL_PATH should be the absolute path and name of the perl script
1456 # The PERL_PATH should be the absolute path and name of the perl script
1457 # interpreter (i.e. the result of `which perl').
1457 # interpreter (i.e. the result of `which perl').
1458
1458
1459 PERL_PATH = /usr/bin/perl
1459 PERL_PATH = /usr/bin/perl
1460
1460
1461 #---------------------------------------------------------------------------
1461 #---------------------------------------------------------------------------
1462 # Configuration options related to the dot tool
1462 # Configuration options related to the dot tool
1463 #---------------------------------------------------------------------------
1463 #---------------------------------------------------------------------------
1464
1464
1465 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1465 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1466 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1466 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1467 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1467 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1468 # this option is superseded by the HAVE_DOT option below. This is only a
1468 # this option is superseded by the HAVE_DOT option below. This is only a
1469 # fallback. It is recommended to install and use dot, since it yields more
1469 # fallback. It is recommended to install and use dot, since it yields more
1470 # powerful graphs.
1470 # powerful graphs.
1471
1471
1472 CLASS_DIAGRAMS = YES
1472 CLASS_DIAGRAMS = YES
1473
1473
1474 # You can define message sequence charts within doxygen comments using the \msc
1474 # You can define message sequence charts within doxygen comments using the \msc
1475 # command. Doxygen will then run the mscgen tool (see
1475 # command. Doxygen will then run the mscgen tool (see
1476 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1476 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1477 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1477 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1478 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1478 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1479 # default search path.
1479 # default search path.
1480
1480
1481 MSCGEN_PATH =
1481 MSCGEN_PATH =
1482
1482
1483 # If set to YES, the inheritance and collaboration graphs will hide
1483 # If set to YES, the inheritance and collaboration graphs will hide
1484 # inheritance and usage relations if the target is undocumented
1484 # inheritance and usage relations if the target is undocumented
1485 # or is not a class.
1485 # or is not a class.
1486
1486
1487 HIDE_UNDOC_RELATIONS = YES
1487 HIDE_UNDOC_RELATIONS = YES
1488
1488
1489 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1489 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1490 # available from the path. This tool is part of Graphviz, a graph visualization
1490 # available from the path. This tool is part of Graphviz, a graph visualization
1491 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1491 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1492 # have no effect if this option is set to NO (the default)
1492 # have no effect if this option is set to NO (the default)
1493
1493
1494 HAVE_DOT = NO
1494 HAVE_DOT = YES
1495
1495
1496 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1496 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1497 # allowed to run in parallel. When set to 0 (the default) doxygen will
1497 # allowed to run in parallel. When set to 0 (the default) doxygen will
1498 # base this on the number of processors available in the system. You can set it
1498 # base this on the number of processors available in the system. You can set it
1499 # explicitly to a value larger than 0 to get control over the balance
1499 # explicitly to a value larger than 0 to get control over the balance
1500 # between CPU load and processing speed.
1500 # between CPU load and processing speed.
1501
1501
1502 DOT_NUM_THREADS = 0
1502 DOT_NUM_THREADS = 0
1503
1503
1504 # By default doxygen will write a font called FreeSans.ttf to the output
1504 # By default doxygen will write a font called FreeSans.ttf to the output
1505 # directory and reference it in all dot files that doxygen generates. This
1505 # directory and reference it in all dot files that doxygen generates. This
1506 # font does not include all possible unicode characters however, so when you need
1506 # font does not include all possible unicode characters however, so when you need
1507 # these (or just want a differently looking font) you can specify the font name
1507 # these (or just want a differently looking font) you can specify the font name
1508 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1508 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1509 # which can be done by putting it in a standard location or by setting the
1509 # which can be done by putting it in a standard location or by setting the
1510 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1510 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1511 # containing the font.
1511 # containing the font.
1512
1512
1513 DOT_FONTNAME = FreeSans.ttf
1513 DOT_FONTNAME = FreeSans.ttf
1514
1514
1515 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1515 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1516 # The default size is 10pt.
1516 # The default size is 10pt.
1517
1517
1518 DOT_FONTSIZE = 10
1518 DOT_FONTSIZE = 10
1519
1519
1520 # By default doxygen will tell dot to use the output directory to look for the
1520 # By default doxygen will tell dot to use the output directory to look for the
1521 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1521 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1522 # different font using DOT_FONTNAME you can set the path where dot
1522 # different font using DOT_FONTNAME you can set the path where dot
1523 # can find it using this tag.
1523 # can find it using this tag.
1524
1524
1525 DOT_FONTPATH =
1525 DOT_FONTPATH =
1526
1526
1527 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1527 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1528 # will generate a graph for each documented class showing the direct and
1528 # will generate a graph for each documented class showing the direct and
1529 # indirect inheritance relations. Setting this tag to YES will force the
1529 # indirect inheritance relations. Setting this tag to YES will force the
1530 # the CLASS_DIAGRAMS tag to NO.
1530 # the CLASS_DIAGRAMS tag to NO.
1531
1531
1532 CLASS_GRAPH = YES
1532 CLASS_GRAPH = YES
1533
1533
1534 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1534 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1535 # will generate a graph for each documented class showing the direct and
1535 # will generate a graph for each documented class showing the direct and
1536 # indirect implementation dependencies (inheritance, containment, and
1536 # indirect implementation dependencies (inheritance, containment, and
1537 # class references variables) of the class with other documented classes.
1537 # class references variables) of the class with other documented classes.
1538
1538
1539 COLLABORATION_GRAPH = YES
1539 COLLABORATION_GRAPH = YES
1540
1540
1541 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1541 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1542 # will generate a graph for groups, showing the direct groups dependencies
1542 # will generate a graph for groups, showing the direct groups dependencies
1543
1543
1544 GROUP_GRAPHS = YES
1544 GROUP_GRAPHS = YES
1545
1545
1546 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1546 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1547 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1547 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1548 # Language.
1548 # Language.
1549
1549
1550 UML_LOOK = NO
1550 UML_LOOK = NO
1551
1551
1552 # If set to YES, the inheritance and collaboration graphs will show the
1552 # If set to YES, the inheritance and collaboration graphs will show the
1553 # relations between templates and their instances.
1553 # relations between templates and their instances.
1554
1554
1555 TEMPLATE_RELATIONS = NO
1555 TEMPLATE_RELATIONS = NO
1556
1556
1557 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1557 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1558 # tags are set to YES then doxygen will generate a graph for each documented
1558 # tags are set to YES then doxygen will generate a graph for each documented
1559 # file showing the direct and indirect include dependencies of the file with
1559 # file showing the direct and indirect include dependencies of the file with
1560 # other documented files.
1560 # other documented files.
1561
1561
1562 INCLUDE_GRAPH = YES
1562 INCLUDE_GRAPH = YES
1563
1563
1564 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1564 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1565 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1565 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1566 # documented header file showing the documented files that directly or
1566 # documented header file showing the documented files that directly or
1567 # indirectly include this file.
1567 # indirectly include this file.
1568
1568
1569 INCLUDED_BY_GRAPH = YES
1569 INCLUDED_BY_GRAPH = YES
1570
1570
1571 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1571 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1572 # doxygen will generate a call dependency graph for every global function
1572 # doxygen will generate a call dependency graph for every global function
1573 # or class method. Note that enabling this option will significantly increase
1573 # or class method. Note that enabling this option will significantly increase
1574 # the time of a run. So in most cases it will be better to enable call graphs
1574 # the time of a run. So in most cases it will be better to enable call graphs
1575 # for selected functions only using the \callgraph command.
1575 # for selected functions only using the \callgraph command.
1576
1576
1577 CALL_GRAPH = NO
1577 CALL_GRAPH = NO
1578
1578
1579 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1579 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1580 # doxygen will generate a caller dependency graph for every global function
1580 # doxygen will generate a caller dependency graph for every global function
1581 # or class method. Note that enabling this option will significantly increase
1581 # or class method. Note that enabling this option will significantly increase
1582 # the time of a run. So in most cases it will be better to enable caller
1582 # the time of a run. So in most cases it will be better to enable caller
1583 # graphs for selected functions only using the \callergraph command.
1583 # graphs for selected functions only using the \callergraph command.
1584
1584
1585 CALLER_GRAPH = NO
1585 CALLER_GRAPH = NO
1586
1586
1587 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1587 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1588 # will graphical hierarchy of all classes instead of a textual one.
1588 # will graphical hierarchy of all classes instead of a textual one.
1589
1589
1590 GRAPHICAL_HIERARCHY = YES
1590 GRAPHICAL_HIERARCHY = YES
1591
1591
1592 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1592 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1593 # then doxygen will show the dependencies a directory has on other directories
1593 # then doxygen will show the dependencies a directory has on other directories
1594 # in a graphical way. The dependency relations are determined by the #include
1594 # in a graphical way. The dependency relations are determined by the #include
1595 # relations between the files in the directories.
1595 # relations between the files in the directories.
1596
1596
1597 DIRECTORY_GRAPH = YES
1597 DIRECTORY_GRAPH = YES
1598
1598
1599 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1599 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1600 # generated by dot. Possible values are png, jpg, or gif
1600 # generated by dot. Possible values are png, jpg, or gif
1601 # If left blank png will be used.
1601 # If left blank png will be used.
1602
1602
1603 DOT_IMAGE_FORMAT = png
1603 DOT_IMAGE_FORMAT = png
1604
1604
1605 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1605 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1606 # found. If left blank, it is assumed the dot tool can be found in the path.
1606 # found. If left blank, it is assumed the dot tool can be found in the path.
1607
1607
1608 DOT_PATH =
1608 DOT_PATH =
1609
1609
1610 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1610 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1611 # contain dot files that are included in the documentation (see the
1611 # contain dot files that are included in the documentation (see the
1612 # \dotfile command).
1612 # \dotfile command).
1613
1613
1614 DOTFILE_DIRS =
1614 DOTFILE_DIRS =
1615
1615
1616 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1616 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1617 # nodes that will be shown in the graph. If the number of nodes in a graph
1617 # nodes that will be shown in the graph. If the number of nodes in a graph
1618 # becomes larger than this value, doxygen will truncate the graph, which is
1618 # becomes larger than this value, doxygen will truncate the graph, which is
1619 # visualized by representing a node as a red box. Note that doxygen if the
1619 # visualized by representing a node as a red box. Note that doxygen if the
1620 # number of direct children of the root node in a graph is already larger than
1620 # number of direct children of the root node in a graph is already larger than
1621 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1621 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1622 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1622 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1623
1623
1624 DOT_GRAPH_MAX_NODES = 50
1624 DOT_GRAPH_MAX_NODES = 50
1625
1625
1626 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1626 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1627 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1627 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1628 # from the root by following a path via at most 3 edges will be shown. Nodes
1628 # from the root by following a path via at most 3 edges will be shown. Nodes
1629 # that lay further from the root node will be omitted. Note that setting this
1629 # that lay further from the root node will be omitted. Note that setting this
1630 # option to 1 or 2 may greatly reduce the computation time needed for large
1630 # option to 1 or 2 may greatly reduce the computation time needed for large
1631 # code bases. Also note that the size of a graph can be further restricted by
1631 # code bases. Also note that the size of a graph can be further restricted by
1632 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1632 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1633
1633
1634 MAX_DOT_GRAPH_DEPTH = 0
1634 MAX_DOT_GRAPH_DEPTH = 0
1635
1635
1636 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1636 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1637 # background. This is disabled by default, because dot on Windows does not
1637 # background. This is disabled by default, because dot on Windows does not
1638 # seem to support this out of the box. Warning: Depending on the platform used,
1638 # seem to support this out of the box. Warning: Depending on the platform used,
1639 # enabling this option may lead to badly anti-aliased labels on the edges of
1639 # enabling this option may lead to badly anti-aliased labels on the edges of
1640 # a graph (i.e. they become hard to read).
1640 # a graph (i.e. they become hard to read).
1641
1641
1642 DOT_TRANSPARENT = NO
1642 DOT_TRANSPARENT = NO
1643
1643
1644 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1644 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1645 # files in one run (i.e. multiple -o and -T options on the command line). This
1645 # files in one run (i.e. multiple -o and -T options on the command line). This
1646 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1646 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1647 # support this, this feature is disabled by default.
1647 # support this, this feature is disabled by default.
1648
1648
1649 DOT_MULTI_TARGETS = NO
1649 DOT_MULTI_TARGETS = NO
1650
1650
1651 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1651 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1652 # generate a legend page explaining the meaning of the various boxes and
1652 # generate a legend page explaining the meaning of the various boxes and
1653 # arrows in the dot generated graphs.
1653 # arrows in the dot generated graphs.
1654
1654
1655 GENERATE_LEGEND = YES
1655 GENERATE_LEGEND = YES
1656
1656
1657 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1657 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1658 # remove the intermediate dot files that are used to generate
1658 # remove the intermediate dot files that are used to generate
1659 # the various graphs.
1659 # the various graphs.
1660
1660
1661 DOT_CLEANUP = YES
1661 DOT_CLEANUP = YES
Show file before | Show file after | Hide comments
@@ -1,162 +1,173
1 ------------------------------------------------------------------------------
1 ------------------------------------------------------------------------------
2 -- This file is a part of the LPP VHDL IP LIBRARY
2 -- This file is a part of the LPP VHDL IP LIBRARY
3 -- Copyright (C) 2009 - 2010, Laboratory of Plasmas Physic - CNRS
3 -- Copyright (C) 2009 - 2010, Laboratory of Plasmas Physic - CNRS
4 --
4 --
5 -- This program is free software; you can redistribute it and/or modify
5 -- This program is free software; you can redistribute it and/or modify
6 -- it under the terms of the GNU General Public License as published by
6 -- it under the terms of the GNU General Public License as published by
7 -- the Free Software Foundation; either version 2 of the License, or
7 -- the Free Software Foundation; either version 2 of the License, or
8 -- (at your option) any later version.
8 -- (at your option) any later version.
9 --
9 --
10 -- This program is distributed in the hope that it will be useful,
10 -- This program is distributed in the hope that it will be useful,
11 -- but WITHOUT ANY WARRANTY; without even the implied warranty of
11 -- but WITHOUT ANY WARRANTY; without even the implied warranty of
12 -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 -- GNU General Public License for more details.
13 -- GNU General Public License for more details.
14 --
14 --
15 -- You should have received a copy of the GNU General Public License
15 -- You should have received a copy of the GNU General Public License
16 -- along with this program; if not, write to the Free Software
16 -- along with this program; if not, write to the Free Software
17 -- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 -- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 -------------------------------------------------------------------------------
18 -------------------------------------------------------------------------------
19
19
20 library ieee;
20 library ieee;
21 use ieee.std_logic_1164.all;
21 use ieee.std_logic_1164.all;
22
22
23
23
24
24
25 package amba_lcd_16x2_ctrlr is
25 package amba_lcd_16x2_ctrlr is
26
26
27
27
28 type LCD_DRVR_CTRL_BUSS is
28 type LCD_DRVR_CTRL_BUSS is
29 record
29 record
30 LCD_RW : std_logic;
30 LCD_RW : std_logic;
31 LCD_RS : std_logic;
31 LCD_RS : std_logic;
32 LCD_E : std_logic;
32 LCD_E : std_logic;
33 LCD_DATA : std_logic_vector(7 downto 0);
33 LCD_DATA : std_logic_vector(7 downto 0);
34 end record;
34 end record;
35
35
36 type LCD_DRVR_SYNCH_BUSS is
36 type LCD_DRVR_SYNCH_BUSS is
37 record
37 record
38 DRVR_READY : std_logic;
38 DRVR_READY : std_logic;
39 LCD_INITIALISED : std_logic;
39 LCD_INITIALISED : std_logic;
40 end record;
40 end record;
41
41
42
42
43 type LCD_DRVR_CMD_BUSS is
43 type LCD_DRVR_CMD_BUSS is
44 record
44 record
45 Word : std_logic_vector(7 downto 0);
45 Word : std_logic_vector(7 downto 0);
46 CMD_Data : std_logic; --CMD = '0' and data = '1'
46 CMD_Data : std_logic; --CMD = '0' and data = '1'
47 Exec : std_logic;
47 Exec : std_logic;
48 Duration : std_logic_vector(1 downto 0);
48 Duration : std_logic_vector(1 downto 0);
49 end record;
49 end record;
50 type LCD_CFG_Tbl is array(0 to 4) of std_logic_vector(7 downto 0);
50 type LCD_CFG_Tbl is array(0 to 4) of std_logic_vector(7 downto 0);
51
51
52
52
53
53
54 component LCD_16x2_DRIVER is
55 generic(
56 OSC_Freq_MHz : integer:=60
57 );
58 Port ( reset : in STD_LOGIC;
59 clk : in STD_LOGIC;
60 LCD_CTRL : out LCD_DRVR_CTRL_BUSS;
61 SYNCH : out LCD_DRVR_SYNCH_BUSS;
62 DRIVER_CMD : in LCD_DRVR_CMD_BUSS
63 );
64 end component;
54
65
55
66
56
67
57 component amba_lcd_16x2_driver is
68 component amba_lcd_16x2_driver is
58 Port ( reset : in STD_LOGIC;
69 Port ( reset : in STD_LOGIC;
59 clk : in STD_LOGIC;
70 clk : in STD_LOGIC;
60 Bp0 : in STD_LOGIC;
71 Bp0 : in STD_LOGIC;
61 Bp1 : in STD_LOGIC;
72 Bp1 : in STD_LOGIC;
62 Bp2 : in STD_LOGIC;
73 Bp2 : in STD_LOGIC;
63 LCD_data : out STD_LOGIC_VECTOR (7 downto 0);
74 LCD_data : out STD_LOGIC_VECTOR (7 downto 0);
64 LCD_RS : out STD_LOGIC;
75 LCD_RS : out STD_LOGIC;
65 LCD_RW : out STD_LOGIC;
76 LCD_RW : out STD_LOGIC;
66 LCD_E : out STD_LOGIC;
77 LCD_E : out STD_LOGIC;
67 LCD_RET : out STD_LOGIC;
78 LCD_RET : out STD_LOGIC;
68 LCD_CS1 : out STD_LOGIC;
79 LCD_CS1 : out STD_LOGIC;
69 LCD_CS2 : out STD_LOGIC;
80 LCD_CS2 : out STD_LOGIC;
70 SF_CE0 : out std_logic
81 SF_CE0 : out std_logic
71 );
82 );
72 end component;
83 end component;
73
84
74
85
75
86
76 component FRAME_CLK_GEN is
87 component FRAME_CLK_GEN is
77 generic(OSC_freqKHz : integer := 50000);
88 generic(OSC_freqKHz : integer := 50000);
78 Port ( clk : in STD_LOGIC;
89 Port ( clk : in STD_LOGIC;
79 reset : in STD_LOGIC;
90 reset : in STD_LOGIC;
80 FRAME_CLK : out STD_LOGIC);
91 FRAME_CLK : out STD_LOGIC);
81 end component;
92 end component;
82
93
83
94
84
95
85 component LCD_2x16_DRIVER is
96 component LCD_2x16_DRIVER is
86 generic(
97 generic(
87 OSC_Freq_MHz : integer:=60;
98 OSC_Freq_MHz : integer:=60;
88 Refresh_RateHz : integer:=5
99 Refresh_RateHz : integer:=5
89 );
100 );
90 Port ( clk : in STD_LOGIC;
101 Port ( clk : in STD_LOGIC;
91 reset : in STD_LOGIC;
102 reset : in STD_LOGIC;
92 FramBUFF : in STD_LOGIC_VECTOR(16*2*8-1 downto 0);
103 FramBUFF : in STD_LOGIC_VECTOR(16*2*8-1 downto 0);
93 LCD_data : out STD_LOGIC_VECTOR (7 downto 0);
104 LCD_data : out STD_LOGIC_VECTOR (7 downto 0);
94 LCD_RS : out STD_LOGIC;
105 LCD_RS : out STD_LOGIC;
95 LCD_RW : out STD_LOGIC;
106 LCD_RW : out STD_LOGIC;
96 LCD_E : out STD_LOGIC;
107 LCD_E : out STD_LOGIC;
97 LCD_RET : out STD_LOGIC;
108 LCD_RET : out STD_LOGIC;
98 LCD_CS1 : out STD_LOGIC;
109 LCD_CS1 : out STD_LOGIC;
99 LCD_CS2 : out STD_LOGIC;
110 LCD_CS2 : out STD_LOGIC;
100 STATEOUT: out std_logic_vector(3 downto 0);
111 STATEOUT: out std_logic_vector(3 downto 0);
101 refreshPulse : out std_logic
112 refreshPulse : out std_logic
102 );
113 );
103 end component;
114 end component;
104
115
105
116
106 component LCD_CLK_GENERATOR is
117 component LCD_CLK_GENERATOR is
107 generic(OSC_freqKHz : integer := 50000);
118 generic(OSC_freqKHz : integer := 50000);
108 Port ( clk : in STD_LOGIC;
119 Port ( clk : in STD_LOGIC;
109 reset : in STD_LOGIC;
120 reset : in STD_LOGIC;
110 clk_1us : out STD_LOGIC);
121 clk_1us : out STD_LOGIC);
111 end component;
122 end component;
112
123
113 component AMBA_LCD_16x2_DRIVER is
124 component AMBA_LCD_16x2_DRIVER is
114 Port ( reset : in STD_LOGIC;
125 Port ( reset : in STD_LOGIC;
115 clk : in STD_LOGIC;
126 clk : in STD_LOGIC;
116 Bp0 : in STD_LOGIC;
127 Bp0 : in STD_LOGIC;
117 Bp1 : in STD_LOGIC;
128 Bp1 : in STD_LOGIC;
118 Bp2 : in STD_LOGIC;
129 Bp2 : in STD_LOGIC;
119 LCD_data : out STD_LOGIC_VECTOR (7 downto 0);
130 LCD_data : out STD_LOGIC_VECTOR (7 downto 0);
120 LCD_RS : out STD_LOGIC;
131 LCD_RS : out STD_LOGIC;
121 LCD_RW : out STD_LOGIC;
132 LCD_RW : out STD_LOGIC;
122 LCD_E : out STD_LOGIC;
133 LCD_E : out STD_LOGIC;
123 LCD_RET : out STD_LOGIC;
134 LCD_RET : out STD_LOGIC;
124 LCD_CS1 : out STD_LOGIC;
135 LCD_CS1 : out STD_LOGIC;
125 LCD_CS2 : out STD_LOGIC;
136 LCD_CS2 : out STD_LOGIC;
126 SF_CE0 : out std_logic
137 SF_CE0 : out std_logic
127 );
138 );
128 end component;
139 end component;
129
140
130 component LCD_16x2_ENGINE is
141 component LCD_16x2_ENGINE is
131 generic(OSC_freqKHz : integer := 50000);
142 generic(OSC_freqKHz : integer := 50000);
132 Port ( clk : in STD_LOGIC;
143 Port ( clk : in STD_LOGIC;
133 reset : in STD_LOGIC;
144 reset : in STD_LOGIC;
134 DATA : in std_logic_vector(16*2*8-1 downto 0);
145 DATA : in std_logic_vector(16*2*8-1 downto 0);
135 CMD : in std_logic_vector(10 downto 0);
146 CMD : in std_logic_vector(10 downto 0);
136 Exec : in std_logic;
147 Exec : in std_logic;
137 Ready : out std_logic;
148 Ready : out std_logic;
138 LCD_CTRL : out LCD_DRVR_CTRL_BUSS
149 LCD_CTRL : out LCD_DRVR_CTRL_BUSS
139 );
150 );
140 end component;
151 end component;
141
152
142
153
143 component AMBA_LCD_16x2_DRIVER is
154 component AMBA_LCD_16x2_DRIVER is
144 Port ( reset : in STD_LOGIC;
155 Port ( reset : in STD_LOGIC;
145 clk : in STD_LOGIC;
156 clk : in STD_LOGIC;
146 Bp0 : in STD_LOGIC;
157 Bp0 : in STD_LOGIC;
147 Bp1 : in STD_LOGIC;
158 Bp1 : in STD_LOGIC;
148 Bp2 : in STD_LOGIC;
159 Bp2 : in STD_LOGIC;
149 LCD_data : out STD_LOGIC_VECTOR (7 downto 0);
160 LCD_data : out STD_LOGIC_VECTOR (7 downto 0);
150 LCD_RS : out STD_LOGIC;
161 LCD_RS : out STD_LOGIC;
151 LCD_RW : out STD_LOGIC;
162 LCD_RW : out STD_LOGIC;
152 LCD_E : out STD_LOGIC;
163 LCD_E : out STD_LOGIC;
153 LCD_RET : out STD_LOGIC;
164 LCD_RET : out STD_LOGIC;
154 LCD_CS1 : out STD_LOGIC;
165 LCD_CS1 : out STD_LOGIC;
155 LCD_CS2 : out STD_LOGIC;
166 LCD_CS2 : out STD_LOGIC;
156 SF_CE0 : out std_logic
167 SF_CE0 : out std_logic
157 );
168 );
158 end component;
169 end component;
159
170
160
171
161
172
162 end;
173 end;
Show file before | Show file after | Hide comments
@@ -1,356 +1,356
1 \NeedsTeXFormat{LaTeX2e}
1 \NeedsTeXFormat{LaTeX2e}
2 \ProvidesPackage{doxygen}
2 \ProvidesPackage{doxygen}
3
3
4 % Packages used by this style file
4 % Packages used by this style file
5 \RequirePackage{alltt}
5 \RequirePackage{alltt}
6 \RequirePackage{array}
6 \RequirePackage{array}
7 \RequirePackage{calc}
7 \RequirePackage{calc}
8 \RequirePackage{color}
8 \RequirePackage{color}
9 \RequirePackage{fancyhdr}
9 \RequirePackage{fancyhdr}
10 \RequirePackage{verbatim}
10 \RequirePackage{verbatim}
11
11
12 % Setup fancy headings
12 % Setup fancy headings
13 \pagestyle{fancyplain}
13 \pagestyle{fancyplain}
14 \newcommand{\clearemptydoublepage}{%
14 \newcommand{\clearemptydoublepage}{%
15 \newpage{\pagestyle{empty}\cleardoublepage}%
15 \newpage{\pagestyle{empty}\cleardoublepage}%
16 }
16 }
17 \renewcommand{\chaptermark}[1]{%
17 \renewcommand{\chaptermark}[1]{%
18 \markboth{#1}{}%
18 \markboth{#1}{}%
19 }
19 }
20 \renewcommand{\sectionmark}[1]{%
20 \renewcommand{\sectionmark}[1]{%
21 \markright{\thesection\ #1}%
21 \markright{\thesection\ #1}%
22 }
22 }
23 \lhead[\fancyplain{}{\bfseries\thepage}]{%
23 \lhead[\fancyplain{}{\bfseries\thepage}]{%
24 \fancyplain{}{\bfseries\rightmark}%
24 \fancyplain{}{\bfseries\rightmark}%
25 }
25 }
26 \rhead[\fancyplain{}{\bfseries\leftmark}]{%
26 \rhead[\fancyplain{}{\bfseries\leftmark}]{%
27 \fancyplain{}{\bfseries\thepage}%
27 \fancyplain{}{\bfseries\thepage}%
28 }
28 }
29 \rfoot[\fancyplain{}{\bfseries\scriptsize%
29 \rfoot[\fancyplain{}{\bfseries\scriptsize%
30 Generated on Tue Oct 26 2010 19:42:42 for lib-\/lpp by Doxygen }]{}
30 Generated on Wed Oct 27 2010 15:11:34 for lib-\/lpp by Doxygen }]{}
31 \lfoot[]{\fancyplain{}{\bfseries\scriptsize%
31 \lfoot[]{\fancyplain{}{\bfseries\scriptsize%
32 Generated on Tue Oct 26 2010 19:42:42 for lib-\/lpp by Doxygen }}
32 Generated on Wed Oct 27 2010 15:11:34 for lib-\/lpp by Doxygen }}
33 \cfoot{}
33 \cfoot{}
34
34
35 %---------- Internal commands used in this style file ----------------
35 %---------- Internal commands used in this style file ----------------
36
36
37 % Generic environment used by all paragraph-based environments defined
37 % Generic environment used by all paragraph-based environments defined
38 % below. Note that the command \title{...} needs to be defined inside
38 % below. Note that the command \title{...} needs to be defined inside
39 % those environments!
39 % those environments!
40 \newenvironment{DoxyDesc}[1]{%
40 \newenvironment{DoxyDesc}[1]{%
41 \begin{list}{}%
41 \begin{list}{}%
42 {%
42 {%
43 \settowidth{\labelwidth}{40pt}%
43 \settowidth{\labelwidth}{40pt}%
44 \setlength{\leftmargin}{\labelwidth}%
44 \setlength{\leftmargin}{\labelwidth}%
45 \setlength{\parsep}{0pt}%
45 \setlength{\parsep}{0pt}%
46 \setlength{\itemsep}{-4pt}%
46 \setlength{\itemsep}{-4pt}%
47 \renewcommand{\makelabel}{\entrylabel}%
47 \renewcommand{\makelabel}{\entrylabel}%
48 }%
48 }%
49 \item[#1]%
49 \item[#1]%
50 }{%
50 }{%
51 \end{list}%
51 \end{list}%
52 }
52 }
53
53
54 %---------- Commands used by doxygen LaTeX output generator ----------
54 %---------- Commands used by doxygen LaTeX output generator ----------
55
55
56 % Used by <pre> ... </pre>
56 % Used by <pre> ... </pre>
57 \newenvironment{DoxyPre}{%
57 \newenvironment{DoxyPre}{%
58 \small%
58 \small%
59 \begin{alltt}%
59 \begin{alltt}%
60 }{%
60 }{%
61 \end{alltt}%
61 \end{alltt}%
62 \normalsize%
62 \normalsize%
63 }
63 }
64
64
65 % Used by @code ... @endcode
65 % Used by @code ... @endcode
66 \newenvironment{DoxyCode}{%
66 \newenvironment{DoxyCode}{%
67 \footnotesize%
67 \footnotesize%
68 \verbatim%
68 \verbatim%
69 }{%
69 }{%
70 \endverbatim%
70 \endverbatim%
71 \normalsize%
71 \normalsize%
72 }
72 }
73
73
74 % Used by @example, @include, @includelineno and @dontinclude
74 % Used by @example, @include, @includelineno and @dontinclude
75 \newenvironment{DoxyCodeInclude}{%
75 \newenvironment{DoxyCodeInclude}{%
76 \DoxyCode%
76 \DoxyCode%
77 }{%
77 }{%
78 \endDoxyCode%
78 \endDoxyCode%
79 }
79 }
80
80
81 % Used by @verbatim ... @endverbatim
81 % Used by @verbatim ... @endverbatim
82 \newenvironment{DoxyVerb}{%
82 \newenvironment{DoxyVerb}{%
83 \footnotesize%
83 \footnotesize%
84 \verbatim%
84 \verbatim%
85 }{%
85 }{%
86 \endverbatim%
86 \endverbatim%
87 \normalsize%
87 \normalsize%
88 }
88 }
89
89
90 % Used by @verbinclude
90 % Used by @verbinclude
91 \newenvironment{DoxyVerbInclude}{%
91 \newenvironment{DoxyVerbInclude}{%
92 \DoxyVerb%
92 \DoxyVerb%
93 }{%
93 }{%
94 \endDoxyVerb%
94 \endDoxyVerb%
95 }
95 }
96
96
97 % Used by numbered lists (using '-#' or <ol> ... </ol>)
97 % Used by numbered lists (using '-#' or <ol> ... </ol>)
98 \newenvironment{DoxyEnumerate}{%
98 \newenvironment{DoxyEnumerate}{%
99 \enumerate%
99 \enumerate%
100 }{%
100 }{%
101 \endenumerate%
101 \endenumerate%
102 }
102 }
103
103
104 % Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>)
104 % Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>)
105 \newenvironment{DoxyItemize}{%
105 \newenvironment{DoxyItemize}{%
106 \itemize%
106 \itemize%
107 }{%
107 }{%
108 \enditemize%
108 \enditemize%
109 }
109 }
110
110
111 % Used by description lists (using <dl> ... </dl>)
111 % Used by description lists (using <dl> ... </dl>)
112 \newenvironment{DoxyDescription}{%
112 \newenvironment{DoxyDescription}{%
113 \description%
113 \description%
114 }{%
114 }{%
115 \enddescription%
115 \enddescription%
116 }
116 }
117
117
118 % Used by @image, @dotfile, and @dot ... @enddot
118 % Used by @image, @dotfile, and @dot ... @enddot
119 % (only if caption is specified)
119 % (only if caption is specified)
120 \newenvironment{DoxyImage}{%
120 \newenvironment{DoxyImage}{%
121 \begin{figure}[H]%
121 \begin{figure}[H]%
122 \begin{center}%
122 \begin{center}%
123 }{%
123 }{%
124 \end{center}%
124 \end{center}%
125 \end{figure}%
125 \end{figure}%
126 }
126 }
127
127
128 % Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
128 % Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
129 % (only if no caption is specified)
129 % (only if no caption is specified)
130 \newenvironment{DoxyImageNoCaption}{%
130 \newenvironment{DoxyImageNoCaption}{%
131 }{%
131 }{%
132 }
132 }
133
133
134 % Used by @attention
134 % Used by @attention
135 \newenvironment{DoxyAttention}[1]{%
135 \newenvironment{DoxyAttention}[1]{%
136 \begin{DoxyDesc}{#1}%
136 \begin{DoxyDesc}{#1}%
137 }{%
137 }{%
138 \end{DoxyDesc}%
138 \end{DoxyDesc}%
139 }
139 }
140
140
141 % Used by @author and @authors
141 % Used by @author and @authors
142 \newenvironment{DoxyAuthor}[1]{%
142 \newenvironment{DoxyAuthor}[1]{%
143 \begin{DoxyDesc}{#1}%
143 \begin{DoxyDesc}{#1}%
144 }{%
144 }{%
145 \end{DoxyDesc}%
145 \end{DoxyDesc}%
146 }
146 }
147
147
148 % Used by @date
148 % Used by @date
149 \newenvironment{DoxyDate}[1]{%
149 \newenvironment{DoxyDate}[1]{%
150 \begin{DoxyDesc}{#1}%
150 \begin{DoxyDesc}{#1}%
151 }{%
151 }{%
152 \end{DoxyDesc}%
152 \end{DoxyDesc}%
153 }
153 }
154
154
155 % Used by @invariant
155 % Used by @invariant
156 \newenvironment{DoxyInvariant}[1]{%
156 \newenvironment{DoxyInvariant}[1]{%
157 \begin{DoxyDesc}{#1}%
157 \begin{DoxyDesc}{#1}%
158 }{%
158 }{%
159 \end{DoxyDesc}%
159 \end{DoxyDesc}%
160 }
160 }
161
161
162 % Used by @note
162 % Used by @note
163 \newenvironment{DoxyNote}[1]{%
163 \newenvironment{DoxyNote}[1]{%
164 \begin{DoxyDesc}{#1}%
164 \begin{DoxyDesc}{#1}%
165 }{%
165 }{%
166 \end{DoxyDesc}%
166 \end{DoxyDesc}%
167 }
167 }
168
168
169 % Used by @post
169 % Used by @post
170 \newenvironment{DoxyPostcond}[1]{%
170 \newenvironment{DoxyPostcond}[1]{%
171 \begin{DoxyDesc}{#1}%
171 \begin{DoxyDesc}{#1}%
172 }{%
172 }{%
173 \end{DoxyDesc}%
173 \end{DoxyDesc}%
174 }
174 }
175
175
176 % Used by @pre
176 % Used by @pre
177 \newenvironment{DoxyPrecond}[1]{%
177 \newenvironment{DoxyPrecond}[1]{%
178 \begin{DoxyDesc}{#1}%
178 \begin{DoxyDesc}{#1}%
179 }{%
179 }{%
180 \end{DoxyDesc}%
180 \end{DoxyDesc}%
181 }
181 }
182
182
183 % Used by @remark
183 % Used by @remark
184 \newenvironment{DoxyRemark}[1]{%
184 \newenvironment{DoxyRemark}[1]{%
185 \begin{DoxyDesc}{#1}%
185 \begin{DoxyDesc}{#1}%
186 }{%
186 }{%
187 \end{DoxyDesc}%
187 \end{DoxyDesc}%
188 }
188 }
189
189
190 % Used by @return
190 % Used by @return
191 \newenvironment{DoxyReturn}[1]{%
191 \newenvironment{DoxyReturn}[1]{%
192 \begin{DoxyDesc}{#1}%
192 \begin{DoxyDesc}{#1}%
193 }{%
193 }{%
194 \end{DoxyDesc}%
194 \end{DoxyDesc}%
195 }
195 }
196
196
197 % Used by @since
197 % Used by @since
198 \newenvironment{DoxySince}[1]{%
198 \newenvironment{DoxySince}[1]{%
199 \begin{DoxyDesc}{#1}%
199 \begin{DoxyDesc}{#1}%
200 }{%
200 }{%
201 \end{DoxyDesc}%
201 \end{DoxyDesc}%
202 }
202 }
203
203
204 % Used by @see
204 % Used by @see
205 \newenvironment{DoxySeeAlso}[1]{%
205 \newenvironment{DoxySeeAlso}[1]{%
206 \begin{DoxyDesc}{#1}%
206 \begin{DoxyDesc}{#1}%
207 }{%
207 }{%
208 \end{DoxyDesc}%
208 \end{DoxyDesc}%
209 }
209 }
210
210
211 % Used by @version
211 % Used by @version
212 \newenvironment{DoxyVersion}[1]{%
212 \newenvironment{DoxyVersion}[1]{%
213 \begin{DoxyDesc}{#1}%
213 \begin{DoxyDesc}{#1}%
214 }{%
214 }{%
215 \end{DoxyDesc}%
215 \end{DoxyDesc}%
216 }
216 }
217
217
218 % Used by @warning
218 % Used by @warning
219 \newenvironment{DoxyWarning}[1]{%
219 \newenvironment{DoxyWarning}[1]{%
220 \begin{DoxyDesc}{#1}%
220 \begin{DoxyDesc}{#1}%
221 }{%
221 }{%
222 \end{DoxyDesc}%
222 \end{DoxyDesc}%
223 }
223 }
224
224
225 % Used by @internal
225 % Used by @internal
226 \newenvironment{DoxyInternal}[1]{%
226 \newenvironment{DoxyInternal}[1]{%
227 \paragraph*{#1}%
227 \paragraph*{#1}%
228 }{%
228 }{%
229 }
229 }
230
230
231 % Used by @par and @paragraph
231 % Used by @par and @paragraph
232 \newenvironment{DoxyParagraph}[1]{%
232 \newenvironment{DoxyParagraph}[1]{%
233 \begin{list}{}%
233 \begin{list}{}%
234 {%
234 {%
235 \settowidth{\labelwidth}{40pt}%
235 \settowidth{\labelwidth}{40pt}%
236 \setlength{\leftmargin}{\labelwidth}%
236 \setlength{\leftmargin}{\labelwidth}%
237 \setlength{\parsep}{0pt}%
237 \setlength{\parsep}{0pt}%
238 \setlength{\itemsep}{-4pt}%
238 \setlength{\itemsep}{-4pt}%
239 \renewcommand{\makelabel}{\entrylabel}%
239 \renewcommand{\makelabel}{\entrylabel}%
240 }%
240 }%
241 \item[#1]%
241 \item[#1]%
242 }{%
242 }{%
243 \end{list}%
243 \end{list}%
244 }
244 }
245
245
246 % Used by parameter lists
246 % Used by parameter lists
247 \newenvironment{DoxyParams}[1]{%
247 \newenvironment{DoxyParams}[1]{%
248 \begin{DoxyDesc}{#1}%
248 \begin{DoxyDesc}{#1}%
249 \begin{description}%
249 \begin{description}%
250 }{%
250 }{%
251 \end{description}%
251 \end{description}%
252 \end{DoxyDesc}%
252 \end{DoxyDesc}%
253 }
253 }
254
254
255 % is used for parameters within a detailed function description
255 % is used for parameters within a detailed function description
256 \newenvironment{DoxyParamCaption}{%
256 \newenvironment{DoxyParamCaption}{%
257 \renewcommand{\item}[2][]{##1 {\em ##2}}%
257 \renewcommand{\item}[2][]{##1 {\em ##2}}%
258 }{%
258 }{%
259 }
259 }
260
260
261 % Used by return value lists
261 % Used by return value lists
262 \newenvironment{DoxyRetVals}[1]{%
262 \newenvironment{DoxyRetVals}[1]{%
263 \begin{DoxyDesc}{#1}%
263 \begin{DoxyDesc}{#1}%
264 \begin{description}%
264 \begin{description}%
265 }{%
265 }{%
266 \end{description}%
266 \end{description}%
267 \end{DoxyDesc}%
267 \end{DoxyDesc}%
268 }
268 }
269
269
270 % Used by exception lists
270 % Used by exception lists
271 \newenvironment{DoxyExceptions}[1]{%
271 \newenvironment{DoxyExceptions}[1]{%
272 \begin{DoxyDesc}{#1}%
272 \begin{DoxyDesc}{#1}%
273 \begin{description}%
273 \begin{description}%
274 }{%
274 }{%
275 \end{description}%
275 \end{description}%
276 \end{DoxyDesc}%
276 \end{DoxyDesc}%
277 }
277 }
278
278
279 % Used by template parameter lists
279 % Used by template parameter lists
280 \newenvironment{DoxyTemplParams}[1]{%
280 \newenvironment{DoxyTemplParams}[1]{%
281 \begin{DoxyDesc}{#1}%
281 \begin{DoxyDesc}{#1}%
282 \begin{description}%
282 \begin{description}%
283 }{%
283 }{%
284 \end{description}%
284 \end{description}%
285 \end{DoxyDesc}%
285 \end{DoxyDesc}%
286 }
286 }
287
287
288 \newcommand{\doxyref}[3]{\textbf{#1} (\textnormal{#2}\,\pageref{#3})}
288 \newcommand{\doxyref}[3]{\textbf{#1} (\textnormal{#2}\,\pageref{#3})}
289 \newenvironment{DoxyCompactList}
289 \newenvironment{DoxyCompactList}
290 {\begin{list}{}{
290 {\begin{list}{}{
291 \setlength{\leftmargin}{0.5cm}
291 \setlength{\leftmargin}{0.5cm}
292 \setlength{\itemsep}{0pt}
292 \setlength{\itemsep}{0pt}
293 \setlength{\parsep}{0pt}
293 \setlength{\parsep}{0pt}
294 \setlength{\topsep}{0pt}
294 \setlength{\topsep}{0pt}
295 \renewcommand{\makelabel}{\hfill}}}
295 \renewcommand{\makelabel}{\hfill}}}
296 {\end{list}}
296 {\end{list}}
297 \newenvironment{DoxyCompactItemize}
297 \newenvironment{DoxyCompactItemize}
298 {
298 {
299 \begin{itemize}
299 \begin{itemize}
300 \setlength{\itemsep}{-3pt}
300 \setlength{\itemsep}{-3pt}
301 \setlength{\parsep}{0pt}
301 \setlength{\parsep}{0pt}
302 \setlength{\topsep}{0pt}
302 \setlength{\topsep}{0pt}
303 \setlength{\partopsep}{0pt}
303 \setlength{\partopsep}{0pt}
304 }
304 }
305 {\end{itemize}}
305 {\end{itemize}}
306 \newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}
306 \newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}
307 \newlength{\tmplength}
307 \newlength{\tmplength}
308 \newenvironment{TabularC}[1]
308 \newenvironment{TabularC}[1]
309 {
309 {
310 \setlength{\tmplength}
310 \setlength{\tmplength}
311 {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)}
311 {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)}
312 \par\begin{tabular*}{\linewidth}
312 \par\begin{tabular*}{\linewidth}
313 {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|}
313 {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|}
314 }
314 }
315 {\end{tabular*}\par}
315 {\end{tabular*}\par}
316 \newcommand{\entrylabel}[1]{
316 \newcommand{\entrylabel}[1]{
317 {\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{\textbf{#1}}\vspace{1.5\baselineskip}}}}
317 {\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{\textbf{#1}}\vspace{1.5\baselineskip}}}}
318 \newenvironment{Desc}
318 \newenvironment{Desc}
319 {\begin{list}{}
319 {\begin{list}{}
320 {
320 {
321 \settowidth{\labelwidth}{40pt}
321 \settowidth{\labelwidth}{40pt}
322 \setlength{\leftmargin}{\labelwidth}
322 \setlength{\leftmargin}{\labelwidth}
323 \setlength{\parsep}{0pt}
323 \setlength{\parsep}{0pt}
324 \setlength{\itemsep}{-4pt}
324 \setlength{\itemsep}{-4pt}
325 \renewcommand{\makelabel}{\entrylabel}
325 \renewcommand{\makelabel}{\entrylabel}
326 }
326 }
327 }
327 }
328 {\end{list}}
328 {\end{list}}
329 \newenvironment{Indent}
329 \newenvironment{Indent}
330 {\begin{list}{}{\setlength{\leftmargin}{0.5cm}}
330 {\begin{list}{}{\setlength{\leftmargin}{0.5cm}}
331 \item[]\ignorespaces}
331 \item[]\ignorespaces}
332 {\unskip\end{list}}
332 {\unskip\end{list}}
333 \setlength{\parindent}{0cm}
333 \setlength{\parindent}{0cm}
334 \setlength{\parskip}{0.2cm}
334 \setlength{\parskip}{0.2cm}
335 \addtocounter{secnumdepth}{1}
335 \addtocounter{secnumdepth}{1}
336 \sloppy
336 \sloppy
337 \usepackage[T1]{fontenc}
337 \usepackage[T1]{fontenc}
338 \makeatletter
338 \makeatletter
339 \renewcommand{\paragraph}{\@startsection{paragraph}{4}{0ex}%
339 \renewcommand{\paragraph}{\@startsection{paragraph}{4}{0ex}%
340 {-3.25ex plus -1ex minus -0.2ex}%
340 {-3.25ex plus -1ex minus -0.2ex}%
341 {1.5ex plus 0.2ex}%
341 {1.5ex plus 0.2ex}%
342 {\normalfont\normalsize\bfseries}}
342 {\normalfont\normalsize\bfseries}}
343 \makeatother
343 \makeatother
344 \stepcounter{secnumdepth}
344 \stepcounter{secnumdepth}
345 \stepcounter{tocdepth}
345 \stepcounter{tocdepth}
346 \definecolor{comment}{rgb}{0.5,0.0,0.0}
346 \definecolor{comment}{rgb}{0.5,0.0,0.0}
347 \definecolor{keyword}{rgb}{0.0,0.5,0.0}
347 \definecolor{keyword}{rgb}{0.0,0.5,0.0}
348 \definecolor{keywordtype}{rgb}{0.38,0.25,0.125}
348 \definecolor{keywordtype}{rgb}{0.38,0.25,0.125}
349 \definecolor{keywordflow}{rgb}{0.88,0.5,0.0}
349 \definecolor{keywordflow}{rgb}{0.88,0.5,0.0}
350 \definecolor{preprocessor}{rgb}{0.5,0.38,0.125}
350 \definecolor{preprocessor}{rgb}{0.5,0.38,0.125}
351 \definecolor{stringliteral}{rgb}{0.0,0.125,0.25}
351 \definecolor{stringliteral}{rgb}{0.0,0.125,0.25}
352 \definecolor{charliteral}{rgb}{0.0,0.5,0.5}
352 \definecolor{charliteral}{rgb}{0.0,0.5,0.5}
353 \definecolor{vhdldigit}{rgb}{1.0,0.0,1.0}
353 \definecolor{vhdldigit}{rgb}{1.0,0.0,1.0}
354 \definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43}
354 \definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43}
355 \definecolor{vhdllogic}{rgb}{1.0,0.0,0.0}
355 \definecolor{vhdllogic}{rgb}{1.0,0.0,0.0}
356 \definecolor{vhdlchar}{rgb}{0.0,0.0,0.0}
356 \definecolor{vhdlchar}{rgb}{0.0,0.0,0.0}
General Comments 0
You need to be logged in to leave comments. Login now