Skip to content

Commit 6aab6cd

Browse files
committed
config.doxyfile: update for 1.9.7
1 parent 88d10e5 commit 6aab6cd

File tree

1 file changed

+70
-28
lines changed

1 file changed

+70
-28
lines changed

_doxygen/config.doxyfile

Lines changed: 70 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Doxyfile 1.9.6
1+
# Doxyfile 1.9.7
22

33
# This file describes the settings to be used by the documentation system
44
# doxygen (www.doxygen.org) for a project.
@@ -25,6 +25,7 @@
2525

2626
#---------------------------------------------------------------------------
2727

28+
@INCLUDE = xpacks/micro-os-plus-build-helper/doxygen/original-config.doxyfile
2829
@INCLUDE = xpacks/micro-os-plus-build-helper/doxygen/common-config.doxyfile
2930

3031
#---------------------------------------------------------------------------
@@ -170,6 +171,74 @@ INPUT_FILTER = "sed -e 's|__attribute__\s*[(]\s*[(].*[)]\s*[)]||g'"
170171

171172
# IMAGE_PATH =
172173

174+
#---------------------------------------------------------------------------
175+
# Configuration options related to the HTML output
176+
#---------------------------------------------------------------------------
177+
178+
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
179+
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
180+
# it.
181+
# The default directory is: html.
182+
# This tag requires that the tag GENERATE_HTML is set to YES.
183+
184+
HTML_OUTPUT = reference/cmsis-plus
185+
186+
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
187+
# each generated HTML page. If the tag is left blank doxygen will generate a
188+
# standard header.
189+
#
190+
# To get valid HTML the header file that includes any scripts and style sheets
191+
# that doxygen needs, which is dependent on the configuration options used (e.g.
192+
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
193+
# default header using
194+
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
195+
# YourConfigFile
196+
# and then modify the file new_header.html. See also section "Doxygen usage"
197+
# for information on how to generate the default header that doxygen normally
198+
# uses.
199+
# Note: The header is subject to change so you typically have to regenerate the
200+
# default header when upgrading to a newer version of doxygen. For a description
201+
# of the possible markers and block names see the documentation.
202+
# This tag requires that the tag GENERATE_HTML is set to YES.
203+
204+
HTML_HEADER = \
205+
_doxygen/header.html
206+
207+
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
208+
# cascading style sheets that are included after the standard style sheets
209+
# created by doxygen. Using this option one can overrule certain style aspects.
210+
# This is preferred over using HTML_STYLESHEET since it does not replace the
211+
# standard style sheet and is therefore more robust against future updates.
212+
# Doxygen will copy the style sheet files to the output directory.
213+
# Note: The order of the extra style sheet files is of importance (e.g. the last
214+
# style sheet in the list overrules the setting of the previous ones in the
215+
# list).
216+
# Note: Since the styling of scrollbars can currently not be overruled in
217+
# Webkit/Chromium, the styling will be left out of the default doxygen.css if
218+
# one or more extra stylesheets have been specified. So if scrollbar
219+
# customization is desired it has to be added explicitly. For an example see the
220+
# documentation.
221+
# This tag requires that the tag GENERATE_HTML is set to YES.
222+
223+
HTML_EXTRA_STYLESHEET = \
224+
xpacks/xpack-3rd-party-doxygen-awesome-css/doxygen-awesome.css \
225+
xpacks/micro-os-plus-build-helper/doxygen/common-custom.css \
226+
xpacks/micro-os-plus-build-helper/doxygen/cards.css \
227+
228+
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
229+
# other source files which should be copied to the HTML output directory. Note
230+
# that these files will be copied to the base HTML output directory. Use the
231+
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
232+
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
233+
# files will be copied as-is; there are no commands or markers available.
234+
# This tag requires that the tag GENERATE_HTML is set to YES.
235+
236+
HTML_EXTRA_FILES = \
237+
xpacks/xpack-3rd-party-doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \
238+
xpacks/xpack-3rd-party-doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \
239+
xpacks/xpack-3rd-party-doxygen-awesome-css/doxygen-awesome-paragraph-link.js \
240+
xpacks/xpack-3rd-party-doxygen-awesome-css/doxygen-awesome-interactive-toc.js \
241+
xpacks/xpack-3rd-party-doxygen-awesome-css/doxygen-awesome-tabs.js \
173242

174243
#---------------------------------------------------------------------------
175244
# Configuration options related to the preprocessor
@@ -192,31 +261,4 @@ OS_INCLUDE_RTOS_STATISTICS_THREAD_CONTEXT_SWITCHES \
192261
OS_INCLUDE_RTOS_STATISTICS_THREAD_CPU_CYCLES \
193262
OS_INTEGER_RTOS_DYNAMIC_MEMORY_SIZE_BYTES \
194263

195-
196-
#---------------------------------------------------------------------------
197-
# Configuration options related to the HTML output
198-
#---------------------------------------------------------------------------
199-
200-
HTML_OUTPUT = reference/cmsis-plus
201-
202-
HTML_HEADER = \
203-
_doxygen/header.html
204-
205-
HTML_EXTRA_FILES = \
206-
xpacks/xpack-3rd-party-doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \
207-
xpacks/xpack-3rd-party-doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \
208-
xpacks/xpack-3rd-party-doxygen-awesome-css/doxygen-awesome-paragraph-link.js \
209-
xpacks/xpack-3rd-party-doxygen-awesome-css/doxygen-awesome-interactive-toc.js \
210-
xpacks/xpack-3rd-party-doxygen-awesome-css/doxygen-awesome-tabs.js \
211-
212-
HTML_EXTRA_STYLESHEET = \
213-
xpacks/xpack-3rd-party-doxygen-awesome-css/doxygen-awesome.css \
214-
xpacks/micro-os-plus-build-helper/doxygen/common-custom.css \
215-
xpacks/micro-os-plus-build-helper/doxygen/cards.css \
216-
217-
HTML_COLORSTYLE = LIGHT
218-
HTML_COLORSTYLE_HUE = 209
219-
HTML_COLORSTYLE_SAT = 255
220-
HTML_COLORSTYLE_GAMMA = 113
221-
222264
#---------------------------------------------------------------------------

0 commit comments

Comments
 (0)