Skip to content

Update doxygens to be in sync #8424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 18, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions doxyfile_options
Original file line number Diff line number Diff line change
Expand Up @@ -514,7 +514,7 @@ INTERNAL_DOCS = NO
# and Mac users are advised to set this option to NO.
# The default value is: system dependent.

CASE_SENSE_NAMES = YES
CASE_SENSE_NAMES = NO

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

FILE_PATTERNS = *.h
FILE_PATTERNS = *.h DOXYGEN_FRONTPAGE.md

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

USE_MDFILE_AS_MAINPAGE =
USE_MDFILE_AS_MAINPAGE = DOXYGEN_FRONTPAGE.md

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

DISABLE_INDEX = YES
DISABLE_INDEX = NO

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

SEARCHENGINE = NO
SEARCHENGINE = YES

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

GENERATE_XML = YES
GENERATE_XML = NO

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

XML_OUTPUT = BUILD/xml
XML_OUTPUT = xml

# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
# listings (including syntax highlighting and cross-referencing information) to
Expand Down Expand Up @@ -2075,7 +2075,6 @@ PREDEFINED = DOXYGEN_ONLY \
DEVICE_CRC \
DEVICE_ETHERNET \
DEVICE_EMAC \
DEVICE_ETH \
DEVICE_FLASH \
DEVICE_I2C \
DEVICE_I2CSLAVE \
Expand Down Expand Up @@ -2184,7 +2183,7 @@ PERL_PATH = /usr/bin/perl
# powerful graphs.
# The default value is: YES.

CLASS_DIAGRAMS = NO
CLASS_DIAGRAMS = YES

# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see:
Expand Down
37 changes: 35 additions & 2 deletions doxygen_options.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"PROJECT_NAME": "Mbed OS Reference",
"PROJECT_NAME": "\"Mbed OS Reference\"",
"ENABLE_PREPROCESSING": "YES",
"MACRO_EXPANSION": "YES",
"EXPAND_ONLY_PREDEF": "NO",
Expand All @@ -10,5 +10,38 @@
"EXPAND_AS_DEFINED": "",
"SKIP_FUNCTION_MACROS": "NO",
"STRIP_CODE_COMMENTS": "NO",
"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/*"
"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/*",
"ALPHABETICAL_INDEX": "NO",
"CASE_SENSE_NAMES": "NO",
"DOT_MULTI_TARGETS": "YES",
"EXCLUDE_SYMLINKS": "YES",
"EXTRACT_ANON_NSPACES": "YES",
"EXTRACT_LOCAL_CLASSES": "NO",
"EXTRACT_STATIC": "YES",
"FILE_PATTERNS": "*.h DOXYGEN_FRONTPAGE.md",
"FULL_PATH_NAMES": "NO",
"GENERATE_BUGLIST": "NO",
"GENERATE_LATEX": "NO",
"GENERATE_TESTLIST": "NO",
"GENERATE_TODOLIST": "NO",
"HIDE_SCOPE_NAMES": "YES",
"HIDE_UNDOC_CLASSES": "YES",
"HIDE_UNDOC_MEMBERS": "YES",
"INLINE_INFO": "NO",
"INLINE_INHERITED_MEMB": "YES",
"JAVADOC_AUTOBRIEF": "YES",
"PAPER_TYPE": "a4wide",
"QUIET": "YES",
"REFERENCES_LINK_SOURCE": "NO",
"SHOW_USED_FILES": "NO",
"SOURCE_BROWSER": "YES",
"ALWAYS_DETAILED_SEC": "YES",

"INPUT": "mbed-os",
"HTML_OUTPUT": "html",

"RECURSIVE": "YES",
"OPTIMIZE_OUTPUT_FOR_C": "YES",
"USE_MDFILE_AS_MAINPAGE": "DOXYGEN_FRONTPAGE.md",
"SEARCHENGINE": "YES"
}