Skip to content

Commit d5a7783

Browse files
authored
Update Doxygen style template (#43)
1 parent dafc4d3 commit d5a7783

17 files changed

Lines changed: 3125 additions & 1824 deletions

Documentation/Doxygen/driver.dxy.in

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ PROJECT_BRIEF = "MCU independent CMSIS-Driver implementations"
6161
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
6262
# the logo to the output directory.
6363

64-
PROJECT_LOGO = style_template/cmsis_logo_white_small.png
64+
PROJECT_LOGO = ./style_template/cmsis_logo_white_small.png
6565

6666
# With the PROJECT_ICON tag one can specify an icon that is included in the tabs
6767
# when the HTML document is shown. Doxygen will copy the logo to the output
@@ -290,7 +290,12 @@ TAB_SIZE = 2
290290
# with the commands \{ and \} for these it is advised to use the version @{ and
291291
# @} or use a double escape (\\{ and \\})
292292

293-
ALIASES =
293+
ALIASES = "token{1}=<span class=\"XML-Token\">\1</span>" \
294+
"div{1}=<hr><div class=\"\1\">" \
295+
"enddiv= </div>" \
296+
"func{1}=<kbd>\1</kbd> <br>" \
297+
"copybrief{1}=<br> \copybrief \1 <br>" \
298+
"none=\em none <br>"
294299

295300
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
296301
# only. Doxygen will then generate output that is more tailored for C. For
@@ -534,13 +539,13 @@ TIMESTAMP = YES
534539
# normally produced when WARNINGS is set to YES.
535540
# The default value is: NO.
536541

537-
EXTRACT_ALL = YES
542+
EXTRACT_ALL = NO
538543

539544
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
540545
# be included in the documentation.
541546
# The default value is: NO.
542547

543-
EXTRACT_PRIVATE = YES
548+
EXTRACT_PRIVATE = NO
544549

545550
# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
546551
# methods of a class will be included in the documentation.
@@ -558,23 +563,23 @@ EXTRACT_PACKAGE = NO
558563
# included in the documentation.
559564
# The default value is: NO.
560565

561-
EXTRACT_STATIC = YES
566+
EXTRACT_STATIC = NO
562567

563568
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
564569
# locally in source files will be included in the documentation. If set to NO,
565570
# only classes defined in header files are included. Does not have any effect
566571
# for Java sources.
567572
# The default value is: YES.
568573

569-
EXTRACT_LOCAL_CLASSES = NO
574+
EXTRACT_LOCAL_CLASSES = YES
570575

571576
# This flag is only useful for Objective-C code. If set to YES, local methods,
572577
# which are defined in the implementation section but not in the interface are
573578
# included in the documentation. If set to NO, only methods in the interface are
574579
# included.
575580
# The default value is: NO.
576581

577-
EXTRACT_LOCAL_METHODS = YES
582+
EXTRACT_LOCAL_METHODS = NO
578583

579584
# If this flag is set to YES, the members of anonymous namespaces will be
580585
# extracted and appear in the documentation as a namespace called
@@ -839,7 +844,7 @@ FILE_VERSION_FILTER =
839844
# DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE
840845
# tag is left empty.
841846

842-
LAYOUT_FILE = style_template/layout.xml
847+
LAYOUT_FILE = ./style_template/layout.xml
843848

844849
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
845850
# the reference definitions. This must be a list of .bib files. The .bib
@@ -1092,7 +1097,7 @@ FILE_PATTERNS = *.c \
10921097
# be searched for input files as well.
10931098
# The default value is: NO.
10941099

1095-
RECURSIVE = YES
1100+
RECURSIVE = NO
10961101

10971102
# The EXCLUDE tag can be used to specify files and/or directories that should be
10981103
# excluded from the INPUT source files. This way you can easily exclude a
@@ -1263,13 +1268,13 @@ STRIP_CODE_COMMENTS = YES
12631268
# entity all documented functions referencing it will be listed.
12641269
# The default value is: NO.
12651270

1266-
REFERENCED_BY_RELATION = YES
1271+
REFERENCED_BY_RELATION = NO
12671272

12681273
# If the REFERENCES_RELATION tag is set to YES then for each documented function
12691274
# all documented entities called/used by that function will be listed.
12701275
# The default value is: NO.
12711276

1272-
REFERENCES_RELATION = YES
1277+
REFERENCES_RELATION = NO
12731278

12741279
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
12751280
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
@@ -1421,7 +1426,7 @@ HTML_FILE_EXTENSION = .html
14211426
# of the possible markers and block names see the documentation.
14221427
# This tag requires that the tag GENERATE_HTML is set to YES.
14231428

1424-
HTML_HEADER = style_template/header.html
1429+
HTML_HEADER = ./style_template/header.html
14251430

14261431
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
14271432
# generated HTML page. If the tag is left blank Doxygen will generate a standard
@@ -1431,7 +1436,7 @@ HTML_HEADER = style_template/header.html
14311436
# that Doxygen normally uses.
14321437
# This tag requires that the tag GENERATE_HTML is set to YES.
14331438

1434-
HTML_FOOTER = style_template/footer.html
1439+
HTML_FOOTER = ./style_template/footer.html
14351440

14361441
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
14371442
# sheet that is used by each HTML page. It can be used to fine-tune the look of
@@ -1461,8 +1466,11 @@ HTML_STYLESHEET =
14611466
# documentation.
14621467
# This tag requires that the tag GENERATE_HTML is set to YES.
14631468

1464-
HTML_EXTRA_STYLESHEET = style_template/extra_stylesheet.css \
1465-
style_template/extra_search.css
1469+
HTML_EXTRA_STYLESHEET = ./style_template/extra_stylesheet.css \
1470+
./style_template/extra_navtree.css \
1471+
./style_template/extra_search.css \
1472+
./style_template/extra_tabs.css \
1473+
./style_template/version.css
14661474

14671475
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
14681476
# other source files which should be copied to the HTML output directory. Note
@@ -1472,15 +1480,11 @@ HTML_EXTRA_STYLESHEET = style_template/extra_stylesheet.css \
14721480
# files will be copied as-is; there are no commands or markers available.
14731481
# This tag requires that the tag GENERATE_HTML is set to YES.
14741482

1475-
HTML_EXTRA_FILES = style_template/tabs.css \
1476-
style_template/search.css \
1477-
style_template/navtree.css \
1478-
style_template/tab_b.png \
1479-
style_template/navtree.js \
1480-
style_template/version.css \
1481-
style_template/dropdown.png \
1482-
style_template/bdwn.png \
1483-
../../LICENSE
1483+
HTML_EXTRA_FILES = ./style_template/tab_b.png \
1484+
./style_template/tabs.js \
1485+
./style_template/darkmode_toggle.js \
1486+
./style_template/navtree.js \
1487+
./style_template/dropdown.png
14841488

14851489
# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
14861490
# should be rendered with a dark or light theme.
@@ -1493,7 +1497,7 @@ HTML_EXTRA_FILES = style_template/tabs.css \
14931497
# The default value is: AUTO_LIGHT.
14941498
# This tag requires that the tag GENERATE_HTML is set to YES.
14951499

1496-
HTML_COLORSTYLE = AUTO_LIGHT
1500+
HTML_COLORSTYLE = TOGGLE
14971501

14981502
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
14991503
# will adjust the colors in the style sheet and background images according to

Documentation/Doxygen/linkchecker.rc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ ignoreerrors=
66
mag_seld.svg
77
../tab_a.png
88
../tab_ad.png
9-
9+
minus.svg
10+
plus.svg
11+
minusd.svg
12+
plusd.svg
13+
1014
[filtering]
1115
ignorewarnings=
1216
http-redirected
-147 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)