Skip to content

GitLab

Last edited by Aaron Bray
Page history

Generating Documentation

The Pulse physiology platform includes functionality to generate html documentation. This includes in-code documentation, data model design description, and physiology system methodology reports. The html files are generated using Doxygen and custom Java applications.

You will have to have the code and baselines all pulled and built to generate documentation.

Install the following tools:

  • Install Doxygen v1.8.13, and ensure it is added to your Path.
  • Install Perl, and ensure it is added to your Path. For windows, we use Strawberry Perl
  • Install Ghostscript 9.26, and ensure it is added to your Path. For windows, get the 32bit version.
  • Install a LaTeX generator, and ensure it is added to your Path. For windows, we use MiKTeX

Here is an example of for setting up the required tools to your PATH

set PATH=%PATH%;N:/Programming/Tools/strawberry-perl-5.28.1.1/c/bin
set PATH=%PATH%;N:/Programming/Tools/strawberry-perl-5.28.1.1/site/bin
set PATH=%PATH%;N:/Programming/Tools/strawberry-perl-5.28.1.1/perl/bin
set PATH=%PATH%;N:/Programming/Tools/gs9.26/bin
set PATH=%PATH%;N:/Programming/Tools/MiKTeX 2.9/miktex/bin/x64/
set PATH=%PATH%;N:/Programming/Tools/doxygen-1.8.13/

To generate the documentation, perform the following steps:

  • Execute SystemValidation and PatientValidation CMake scripts as described on the Wiki Homepage to generate validation tables
  • Execute the doxygen CMake script as described on the Wiki Homepage to generate the html

Once generated, the homepage can be found at <pulse/build>/install/bin/docs/html/index.html.