Skip to content

Commit 0b43763

Browse files
[doc] Fix of the documentation's build #21967 (#22180)
The Doxygen configuration file does not allow the generation of the documentation. To solve this problem, I made some changes: * I excluded symbolic links to avoid infinite recurrences. * I excluded the "third_party" which causes too many troubles. I disabled the transformation of the warning into an error because there's few warning during documentation generation. I have deliberately not made any changes so as not to be too intrusive. I invite the managers of these parts to make corrections that will certainly be more relevant than mine. I put logs file on ticket. Doc entry point: ./docs/html/index.html Build command: CHIP_NAME="xxxx" CHIP_VERSION="v x.y.z" doxygen ./docs/Doxyfile
1 parent d47c8f7 commit 0b43763

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/Doxyfile

+4-4
Original file line numberDiff line numberDiff line change
@@ -795,7 +795,7 @@ WARN_NO_PARAMDOC = NO
795795
# a warning is encountered.
796796
# The default value is: NO.
797797

798-
WARN_AS_ERROR = YES
798+
WARN_AS_ERROR = NO
799799

800800
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
801801
# can produce. The string should contain the $file, $line, and $text tags, which
@@ -919,14 +919,14 @@ RECURSIVE = YES
919919
# Note that relative paths are relative to the directory from which doxygen is
920920
# run.
921921

922-
EXCLUDE =
922+
EXCLUDE = third_party
923923

924924
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
925925
# directories that are symbolic links (a Unix file system feature) are excluded
926926
# from the input.
927927
# The default value is: NO.
928928

929-
EXCLUDE_SYMLINKS = NO
929+
EXCLUDE_SYMLINKS = YES
930930

931931
# If the value of the INPUT tag contains directories, you can use the
932932
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
@@ -2172,7 +2172,7 @@ SEARCH_INCLUDES = YES
21722172
# preprocessor.
21732173
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
21742174

2175-
INCLUDE_PATH = third_party/
2175+
INCLUDE_PATH =
21762176

21772177
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
21782178
# patterns (like *.h and *.hpp) to filter out the header-files in the

0 commit comments

Comments
 (0)