Skip to content

Commit

Permalink
Merge pull request #5190 from prckent/doxygencleanup
Browse files Browse the repository at this point in the history
Improve doxygen docs + cleanup
  • Loading branch information
ye-luo authored Sep 26, 2024
2 parents 92746e6 + 427f5a4 commit 0a1b901
Show file tree
Hide file tree
Showing 118 changed files with 9 additions and 3 deletions.
6 changes: 6 additions & 0 deletions docs/external_tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ In general:

These set the basic flags required to build with either of these sanitizer libraries which are mutually exclusive. Depending on your system and linker, these may be incompatible with the "Release" build, so set ``-DCMAKE_BUILD_TYPE=Debug`` or ``-DCMAKE_BUILD_TYPE=RelWithDebInfo``. They are tested on GitHub Actions CI using deterministic tests ``ctest -L deterministic`` (currently ubsan). See the following links for additional information on use, run time, and build options of the sanitizers: https://clang.llvm.org/docs/AddressSanitizer.html & https://clang.llvm.org/docs/MemorySanitizer.html.

Doxygen source documentation
----------------------------

If doxygen and optionally dot from graphviz are detected by CMake, a qmcpack_doxygen target will be defined. ``make qmcpack_doxygen`` will then generate html-based
documentation in the build directory. This target is not enabled by default because generation of the documentation may take several minutes. This automatically
generated documentation includes class diagrams and browsable and searchable lists of all functions, classes, and files.

Intel VTune
-----------
Expand Down
6 changes: 3 additions & 3 deletions doxygen/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
find_package(Doxygen)
if(NOT DOXYGEN_FOUND)
message(STATUS "The qmcpack_doxygen target for the QMCPACK developer/API "
"documentation requires doxygen and (optionally) dot from graphviz."
)
message(STATUS "doxygen not found. Source code documentation via qmcpack_doxygen target requires doxygen and (optionally) dot from graphviz.")
return()
else()
message(STATUS "doxygen found. For source code documentation build the qmcpack_doxygen target.")
endif()

set(DOXYGEN_PROJECT_NAME QMCPACK)
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 0a1b901

Please sign in to comment.