Doxygen fixes (#2718)
* warning: explicit link request to 'ifdef' could not be resolved
* warning: documented symbol 'chip::Platform::Security::AES128BlockCipher::*' was not declared or defined.
* warning: documentation for unknown define CHIP_SYSTEM_CONFIG_USE_ZEPHYR_* found.
* src/system/SystemError.h:165: warning: unbalanced grouping commands
* warning: documentation for unknown define CHIP_DEVICE_ERROR_CONFIG_VALUE_NOT_FOUND found.
* warning: explicit link request to 'CHIP_SYSTEM_ERROR_*' could not be resolved
* Ignore src/app until the code is cleaned up
* warning: argument '*' of command @param is not found in the argument list of chip::System::Platform::Layer::*
* Activate STL in docs/Doxyfile since it is used at some places in the code
* Transport::BLE::* documented function not declared or defined
* warning: the name 'Defines' supplied as the argument in the \file statement is not an input file
* warning: the name 'This' supplied as the argument in the \file statement is not an input file
* Expand more macros than only the ones that are predefined
* argument 'err' of command @param is not found in the argument list of chip::System::*
* InetUtils.cpp - warning: Unsupported xml/html tag
* efr32-chip-mbedtls-config.h: warning: documentation for unknown define MBEDTLS*
* Various misnames parameters or duplicate parameters in src/inet
* warning: argument '*' of command @param is not found
* unable to resolve reference to *
* Missing params in src/transport
* warning: explicit link request to '*' could not be resolved
* warning: documented symbol 'short chip::Inet::InterfaceIterator::GetFlags' was not declared or defined
* warning: no matching class member found for
* Included by graph for '*' not generated, too many nodes (*), threshold is 50. Consider increasing DOT_GRAPH_MAX_NODES.
* Inet::InterfaceId is not documented
* warning: explicit link request to
* warning: Unsupported xml/html tag <platform>
* warning: Found unknown command '@requirements'
* Doxygen is confused by __attribute__ annotation
* Wrong parameter name aType->aEventType
* explicit reference
* src/controller/java/CHIPDeviceController-JNI.cpp confuses doxygen
* Ignore NetworkProvisioningServer* files since those are broken and not used so far
diff --git a/docs/Doxyfile b/docs/Doxyfile
index e611856..1417c8c 100644
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -354,7 +354,7 @@
# diagrams that involve STL classes more complete and accurate.
# The default value is: NO.
-BUILTIN_STL_SUPPORT = NO
+BUILTIN_STL_SUPPORT = YES
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
@@ -485,7 +485,7 @@
# included in the documentation.
# The default value is: NO.
-EXTRACT_STATIC = NO
+EXTRACT_STATIC = YES
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
@@ -824,13 +824,14 @@
# Note: If this tag is empty the current directory is searched.
INPUT = README.md \
+ CODE_OF_CONDUCT.md \
CONTRIBUTING.md \
docs/README.md \
docs/BUILDING.md \
+ docs/BUILDING-GN.md \
docs/VSCODE_DEVELOPMENT.md \
docs/PROJECT_FLOW.md \
docs/STYLE_GUIDE.md \
- src/app \
src/ble \
src/controller \
src/crypto \
@@ -839,6 +840,7 @@
src/lib/core \
src/lib/support \
src/lib/shell \
+ src/lib/message/support/crypto \
src/platform \
src/setup_payload \
src/system \
@@ -933,7 +935,8 @@
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*
-EXCLUDE_PATTERNS = */tests/* \
+EXCLUDE_PATTERNS = NetworkProvisioningServer* \
+ */tests/* \
*/dbus/*
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
@@ -2164,7 +2167,7 @@
# preprocessor.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
-INCLUDE_PATH =
+INCLUDE_PATH = third_party/
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
@@ -2182,7 +2185,9 @@
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-PREDEFINED = CHIP_SYSTEM_CONFIG_USE_SOCKETS=1 \
+PREDEFINED = DOXYGEN=1 \
+ NO_INLINE= \
+ CHIP_SYSTEM_CONFIG_USE_SOCKETS=1 \
CHIP_SYSTEM_CONFIG_USE_LWIP=1 \
INET_CONFIG_ENABLE_IPV4=1 \
CHIP_CONFIG_SECURITY_TEST_MODE=1 \
@@ -2513,7 +2518,7 @@
# Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES.
-DOT_GRAPH_MAX_NODES = 50
+DOT_GRAPH_MAX_NODES = 200
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# generated by dot. A depth value of 3 means that only nodes reachable from the
