Skip to content

Commit

Permalink
[doc] Fix of the documentation's build project-chip#21967 (project-ch…
Browse files Browse the repository at this point in the history
…ip#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
  • Loading branch information
achsoftathome authored and isiu-apple committed Sep 16, 2022
1 parent 1e17591 commit 8b2707e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -795,7 +795,7 @@ WARN_NO_PARAMDOC = NO
# a warning is encountered.
# The default value is: NO.

WARN_AS_ERROR = YES
WARN_AS_ERROR = NO

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

EXCLUDE =
EXCLUDE = third_party

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

EXCLUDE_SYMLINKS = NO
EXCLUDE_SYMLINKS = YES

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

INCLUDE_PATH = third_party/
INCLUDE_PATH =

# 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
Expand Down

0 comments on commit 8b2707e

Please sign in to comment.