Skip to content

Commit 784fa91

Browse files
committed
Update doxygens to be in sync
Make the following changes to doxyfile_options: -Change CASE_SENSE_NAMES so names of files generated match mbed-os docs -Change DISABLE_INDEX so navigation bar shows -Change CLASS_DIAGRAMS so inheritance diagram gets generated -Change USE_MDFILE_AS_MAINPAGE and add DOXYGEN_FRONTPAGE.md to FILE_PATTERNS so the correct main page is found and used -Remove DEVICE_ETH from PREDEFINED since this is no longer relevent -Change GENERATE_XML and XML_OUTPUT so no xml is generated -Change SEARCHENGINE to match the docs Make the following changes in doxygen_options.json: -Add all non-default values in doxyfile_options to the json -Break json into 3 groups 1. Values that are the same as doxyfile_options 2. Values that must be different from doxyfile_options 3. Values the are overriden by the docs builder -Make the doxyegn search directory "INPUT" start in mbed-os rather than one level above mbed-os. Finally, rename the BLE doxygen front page so it is not confused with the mbed-os front page.
1 parent 6d7b655 commit 784fa91

File tree

3 files changed

+43
-11
lines changed

3 files changed

+43
-11
lines changed

doxyfile_options

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -514,7 +514,7 @@ INTERNAL_DOCS = NO
514514
# and Mac users are advised to set this option to NO.
515515
# The default value is: system dependent.
516516

517-
CASE_SENSE_NAMES = YES
517+
CASE_SENSE_NAMES = NO
518518

519519
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
520520
# their full class and namespace scopes in the documentation. If set to YES, the
@@ -805,7 +805,7 @@ INPUT_ENCODING = UTF-8
805805
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
806806
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
807807

808-
FILE_PATTERNS = *.h
808+
FILE_PATTERNS = *.h DOXYGEN_FRONTPAGE.md
809809

810810
# The RECURSIVE tag can be used to specify whether or not subdirectories should
811811
# be searched for input files as well.
@@ -951,7 +951,7 @@ FILTER_SOURCE_PATTERNS =
951951
# (index.html). This can be useful if you have a project on for instance GitHub
952952
# and want to reuse the introduction page also for the doxygen output.
953953

954-
USE_MDFILE_AS_MAINPAGE =
954+
USE_MDFILE_AS_MAINPAGE = DOXYGEN_FRONTPAGE.md
955955

956956
#---------------------------------------------------------------------------
957957
# Configuration options related to source browsing
@@ -1430,7 +1430,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project
14301430
# The default value is: NO.
14311431
# This tag requires that the tag GENERATE_HTML is set to YES.
14321432

1433-
DISABLE_INDEX = YES
1433+
DISABLE_INDEX = NO
14341434

14351435
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
14361436
# structure should be generated to display hierarchical information. If the tag
@@ -1561,7 +1561,7 @@ MATHJAX_CODEFILE =
15611561
# The default value is: YES.
15621562
# This tag requires that the tag GENERATE_HTML is set to YES.
15631563

1564-
SEARCHENGINE = NO
1564+
SEARCHENGINE = YES
15651565

15661566
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
15671567
# implemented using a web server instead of a web client using Javascript. There
@@ -1915,15 +1915,15 @@ MAN_LINKS = NO
19151915
# captures the structure of the code including all documentation.
19161916
# The default value is: NO.
19171917

1918-
GENERATE_XML = YES
1918+
GENERATE_XML = NO
19191919

19201920
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
19211921
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
19221922
# it.
19231923
# The default directory is: xml.
19241924
# This tag requires that the tag GENERATE_XML is set to YES.
19251925

1926-
XML_OUTPUT = BUILD/xml
1926+
XML_OUTPUT = xml
19271927

19281928
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
19291929
# listings (including syntax highlighting and cross-referencing information) to
@@ -2075,7 +2075,6 @@ PREDEFINED = DOXYGEN_ONLY \
20752075
DEVICE_CRC \
20762076
DEVICE_ETHERNET \
20772077
DEVICE_EMAC \
2078-
DEVICE_ETH \
20792078
DEVICE_FLASH \
20802079
DEVICE_I2C \
20812080
DEVICE_I2CSLAVE \
@@ -2184,7 +2183,7 @@ PERL_PATH = /usr/bin/perl
21842183
# powerful graphs.
21852184
# The default value is: YES.
21862185

2187-
CLASS_DIAGRAMS = NO
2186+
CLASS_DIAGRAMS = YES
21882187

21892188
# You can define message sequence charts within doxygen comments using the \msc
21902189
# command. Doxygen will then run the mscgen tool (see:

doxygen_options.json

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"PROJECT_NAME": "Mbed OS Reference",
2+
"PROJECT_NAME": "\"Mbed OS Reference\"",
33
"ENABLE_PREPROCESSING": "YES",
44
"MACRO_EXPANSION": "YES",
55
"EXPAND_ONLY_PREDEF": "NO",
@@ -10,5 +10,38 @@
1010
"EXPAND_AS_DEFINED": "",
1111
"SKIP_FUNCTION_MACROS": "NO",
1212
"STRIP_CODE_COMMENTS": "NO",
13-
"EXCLUDE_PATTERNS": "*/tools/* */targets/* */features/mbedtls/* */features/storage/cfstore/* */features/storage/FEATURE_STORAGE/* */features/unsupported/* */BUILD/* */rtos/TARGET_CORTEX/rtx*/* */cmsis/* */features/lwipstack/* */nanostack/sal-stack-nanostack/* */nanostack/coap-service/* */ble/generic/* */ble/pal/* */mbed-trace/* */mbed-coap/* */nanostack-libservice/* */mbed-client-randlib/* */nanostack/sal-stack-nanostack-eventloop/* */components/802.15.4_RF/* */components/wifi/* */features/nfc/stack/* */UNITTESTS/*"
13+
"EXCLUDE_PATTERNS": "*/tools/* */targets/* */features/mbedtls/* */features/storage/cfstore/* */features/storage/FEATURE_STORAGE/* */features/unsupported/* */BUILD/* */rtos/TARGET_CORTEX/rtx*/* */cmsis/* */features/lwipstack/* */nanostack/sal-stack-nanostack/* */nanostack/coap-service/* */ble/generic/* */ble/pal/* */mbed-trace/* */mbed-coap/* */nanostack-libservice/* */mbed-client-randlib/* */nanostack/sal-stack-nanostack-eventloop/* */components/802.15.4_RF/* */components/wifi/* */features/nfc/stack/* */UNITTESTS/* */features/cryptocell/*",
14+
"ALPHABETICAL_INDEX": "NO",
15+
"CASE_SENSE_NAMES": "NO",
16+
"DOT_MULTI_TARGETS": "YES",
17+
"EXCLUDE_SYMLINKS": "YES",
18+
"EXTRACT_ANON_NSPACES": "YES",
19+
"EXTRACT_LOCAL_CLASSES": "NO",
20+
"EXTRACT_STATIC": "YES",
21+
"FILE_PATTERNS": "*.h DOXYGEN_FRONTPAGE.md",
22+
"FULL_PATH_NAMES": "NO",
23+
"GENERATE_BUGLIST": "NO",
24+
"GENERATE_LATEX": "NO",
25+
"GENERATE_TESTLIST": "NO",
26+
"GENERATE_TODOLIST": "NO",
27+
"HIDE_SCOPE_NAMES": "YES",
28+
"HIDE_UNDOC_CLASSES": "YES",
29+
"HIDE_UNDOC_MEMBERS": "YES",
30+
"INLINE_INFO": "NO",
31+
"INLINE_INHERITED_MEMB": "YES",
32+
"JAVADOC_AUTOBRIEF": "YES",
33+
"PAPER_TYPE": "a4wide",
34+
"QUIET": "YES",
35+
"REFERENCES_LINK_SOURCE": "NO",
36+
"SHOW_USED_FILES": "NO",
37+
"SOURCE_BROWSER": "YES",
38+
"ALWAYS_DETAILED_SEC": "YES",
39+
40+
"INPUT": "mbed-os",
41+
"HTML_OUTPUT": "html",
42+
43+
"RECURSIVE": "YES",
44+
"OPTIMIZE_OUTPUT_FOR_C": "YES",
45+
"USE_MDFILE_AS_MAINPAGE": "DOXYGEN_FRONTPAGE.md",
46+
"SEARCHENGINE": "YES"
1447
}

0 commit comments

Comments
 (0)