Skip to content

lal/lib/fft/RealFFT: remove \section and \subsection to make doxygen 1.10.0 happy

David Keitel requested to merge david-keitel/lalsuite:fix-doxygen-1.10.0-subsubsections into master

Description

Partially addresses #729. Doxygen 1.10.0 doesn't seem to like mixed use of ##/### on the one hand and \section/\subsection on the other hand, like RealFFT.[c/h] do it. This patch, simply changing to all-hashes, seems to work - one loses the anchors defined in the tex-like syntax, but I couldn't find them linked to from anywhere, so I guess it's ok. On the other hand, I couldn't find any note explicitly deprecating the tex-like use, so if there's a more elegant solution @karl-wette feel free to suggest something else.

API Changes and Justification

Backwards Compatible Changes

  • This change does not modify any class/function/struct/type definitions in a public C header file or any Python class/function definitions
  • This change adds new classes/functions/structs/types to a public C header file or Python module

Backwards Incompatible Changes

  • This change modifies an existing class/function/struct/type definition in a public C header file or Python module
  • This change removes an existing class/function/struct/type from a public C header file or Python module

If any of the Backwards Incompatible check boxes are ticked please provide a justification why this change is necessary and why it needs to be done in a backwards incompatible way.

Review Status

Edited by David Keitel

Merge request reports