diff options
| author | Dimitri van Heesch <doxygen@gmail.com> | 2020-07-25 16:59:50 (GMT) |
|---|---|---|
| committer | Dimitri van Heesch <doxygen@gmail.com> | 2020-07-25 16:59:50 (GMT) |
| commit | 483b47ddd8039ba77aacc11d35825489f74b3b47 (patch) | |
| tree | 8dd68c24afcdb4914787a9b23e8ebb8754dec3ee | |
| parent | ab550764edebfcc6f92dd7782d755dd8fa1621fc (diff) | |
| download | Doxygen-483b47ddd8039ba77aacc11d35825489f74b3b47.zip Doxygen-483b47ddd8039ba77aacc11d35825489f74b3b47.tar.gz Doxygen-483b47ddd8039ba77aacc11d35825489f74b3b47.tar.bz2 | |
issue #7921: Help for CLANG_DATABASE_PATH is misleading
| -rw-r--r-- | src/config.xml | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/src/config.xml b/src/config.xml index 7683a4e..9cbe46a 100644 --- a/src/config.xml +++ b/src/config.xml @@ -1705,10 +1705,12 @@ to disable this feature. <docs> <![CDATA[ If clang assisted parsing is enabled you can provide the clang parser with the - path to the <a href="http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html"> - compilation database</a> used when the files were built. This is equivalent to - specifying the "-p" option to a clang tool, such as clang-check. These options - will then be passed to the parser. + path to the directory containing a file called compile_commands.json. + This file is the <a href="http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html"> + compilation database</a> containing the options used when the source files were built. + This is equivalent to specifying the "-p" option to a clang tool, such as clang-check. + These options will then be passed to the parser. Any options specified with + \ref cfg_clang_options "CLANG_OPTIONS" will be added as well. @note The availability of this option depends on whether or not doxygen was generated with the `-Duse_libclang=ON` option for CMake. |