OKlibrary  0.2.1.6
Doxygen.hpp File Reference

Documentation on how to build Doxygen. More...

Go to the source code of this file.


Detailed Description

Documentation on how to build Doxygen.

Installing Doxygen

On the purpose of Doxygen

Doxygen is a program to extract documentation from program sources. We use it for the documentation of C and C++ code as well as for the plans and docus.

What the installation yields

  • Two executables
    1. The doxygen program:
      • Main usage: Takes as input a file with configuration settings, and produces a directory with html-pages.
      • Can also produce a configuration-file template.
      • And can update a configuration file.
    2. The doxytag program (for index-creation).
  • Documentation

The OKlibrary build system provides a link to the doxyen-documentation, and administrates a doxygen-configuration file.

Current state of installation

  • Recommended version = 1.7.6.1
  • Paths to the two executables:
    1. doxygen-program call = /home/csoliver/OKplatform/ExternalSources/Installations/Doxygen/1.7.6.1/bin/doxygen
    2. doxytag-program call = /home/csoliver/OKplatform/ExternalSources/Installations/Doxygen/1.7.6.1/bin/doxytag
  • ready: YES
    • location = /home/csoliver/OKplatform/ExternalSources/Installations/Doxygen/1.7.6.1/bin/doxygen
    • version = 1.7.6.1
  • Documentation: /home/csoliver/OKplatform/system_directories/doc/internet_html/doc/doc/Doxygen/1.7.6.1/html/index.html
  • Doxygen-configuration file:
    1. Template: /home/csoliver/OKplatform/.oklib/Configuration/Html/Doxyfile
    2. Preprocessed configuration file: /home/csoliver/OKplatform/system_directories/aux/Doxyfile
  • Output log-file (error messages only): /home/csoliver/OKplatform/system_directories/log/DoxygenErrorMessages

How to install

Prerequisites

  • gcc is needed (as for many packages).
  • Qt library (often already installed).

Make targets

doxygen Calls sub-targets doxygen_base and doxygen_links
doxygen_base Build the recommended version of doxygen, using the system-gcc.
doxygen_links For local installation, creates links in the public bin-directory.
cleanalldoxygen Remove build, installation and documentation directory.

Configuration

  • Local versus system-wide installation:
    1. The default is local installation.
    2. Set variable doxygen_default_install_okl to value "system" to switch.
  • To install a different version, set variable doxygen_recommended_version_number_okl accordingly.

Definition in file Doxygen.hpp.