Skip to content

lalapps: comment out references to library documentation if that library is not built

Karl Wette requested to merge (removed):lalapps-doxygen-fix-partial-build into master

Description

If building a partial build of LALSuite (e.g. just LAL, LALPulsar, LALApps), the Doxygen build for LALApps fails because it requires links to other libraries, e.g. LALInspiral, who are not included in the build (and for whom the documentation is not available). This patch uses the Doxygen \cond and \endcond commands to comment out documentation which requires a particular library, e.g. \cond LALINSPIRAL comments out documentation if LALInspiral is not available. (This is done through the Doxgen ENABLE_SECTIONS configuration.) This allows my local build to pass make check.

API Changes and Justification

Backwards Compatible Changes

  • This change introduces no API changes
  • This change adds new API calls

Backwards Incompatible Changes

  • This change modifies an existing API
  • This change removes an existing API

Review Status

N/A

Merge request reports