-
Notifications
You must be signed in to change notification settings - Fork 121
How to build Doxygen documentation from elastix source code
Niels Dekker edited this page Jun 21, 2024
·
2 revisions
Elastix allows building documentation from its C++ code, by enabling the CMake flag BUILD_DOCUMENTATION
and running Doxygen on <elastix-build-directory>/help/doxyfile.out
.
On Windows, it consists of the following steps:
- Install CMake (https://cmake.org), Doxygen (https://www.doxygen.nl), GraphViz (https://graphviz.org), MiKTeX (https://miktex.org)
- CMake configure elastix having
BUILD_DOCUMENTATION=ON
. A file named "doxyfile.out" should be created in the "help" subdirectory of the elastix build directory. - If your MiKTeX installation does not have a file named "gswin32c.exe", you may need to rename the file "mgs.exe" to "gswin32c.exe", as workaround to the issue that the Ghostscript executable of the MiKTeX for Windows distribution has been renamed to mgs.exe and therefore does not interfere with any official Ghostscript installation (gswin32c.exe)
- Ensure that "gswin32c.exe", as well as GraphViz dot.exe can be found at the current path and start Doxywizard (Doxygen GUI frontend).
- Within Doxywizard, open the "doxyfile.out" file from
<elastix-build-directory>/help
, get to the Run tab page and click "Run doxygen". Wait until it is finished. Warnings may be ignored. - The doxygen generated HTML should be at
<elastix-build-directory>/help
These steps were take to produce the HTML files at https://elastix.dev/doxygen/