Browse Source

docs: Added exclude to Doxyfile for boschdriver src.

The boschdriver.h file contains tags which are picked up by
doxygen and cause incorrect results.  For example, the
\mainpage and \license cause the Bosch header collateral to
be placed on the index.html page of the UPM docs.

Added an entry to EXCLUDE_PATTERNS which handles this.

Signed-off-by: Noel Eck <noel.eck@intel.com>
Noel Eck 8 years ago
parent
commit
6b273a1b49
1 changed files with 4 additions and 1 deletions
  1. 4
    1
      doxy/Doxyfile.in

+ 4
- 1
doxy/Doxyfile.in View File

@@ -859,7 +859,10 @@ EXCLUDE_SYMLINKS       = NO
859 859
 # Note that the wildcards are matched against the file with absolute path, so to
860 860
 # exclude all test directories for example use the pattern */test/*
861 861
 
862
-EXCLUDE_PATTERNS       = bosch_*
862
+# bme280driver code is provided by bosch.  This source contains tags which are
863
+# picked up by doxygen (namely \mainpage) and incorrectly get added to docs.
864
+EXCLUDE_PATTERNS       = bosch_* \
865
+                         *bme280driver*
863 866
 
864 867
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
865 868
 # (namespaces, classes, functions, etc.) that should be excluded from the