Skip to content

Commit

Permalink
Add an include path to the doxyfile to fix preprocessing for docs
Browse files Browse the repository at this point in the history
Previously, doxygen was unable to effectively use preprocessing to determine
which parts of code should be documented. This was due to its inability to
include headers during preprocessing, which was discovered by running it in
preprocessing debug mode:
doxygen -d preprocessor mbedtls.doxyfile 
An example of failure: "#include mbedtls/config.h: not found! skipping..."
With the following fix includes are properly preprocessed with the documentation
being considerably larger.
Signed-off-by: Andrzej Kurek <andrzej.kurek@arm.com>
  • Loading branch information
Andrzej Kurek committed Mar 31, 2020
1 parent 98911cd commit 593adc8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doxygen/mbedtls.doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -1594,7 +1594,7 @@ SEARCH_INCLUDES = YES
# contain include files that are not input files but should be processed by
# the preprocessor.

INCLUDE_PATH =
INCLUDE_PATH = ../include

# 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 593adc8

Please sign in to comment.