Skip to content

Fix Doxygen comment indentation, /** -> ///

Louis Moureaux requested to merge bugfix/doxygen-comment-indentation into develop

Description

This MR changes all /** and /*! comments to /// comments that clang-format can indent correctly. There should be no functional change.

Most changes were done automatically using an awk script. Some hand tuning was required here and there. Indentation in the comments was preserved; in particular, the comments that used two initial spaces still have two.

This MR will likely cause some changes in the generated documentation because many comments that shouldn't have used /** used it (and some comments use /* or // where /// would have been more appropriate). Since most of the code and documentation is going to be audited anyway, I don't consider this a problem.

Related Issue

First half of #6 (closed). This MR makes no attempt at changing \ to @.

Motivation and Context

See issue #6 (closed).

How Has This Been Tested?

Quick visual inspection of the results for each commit. Code builds and tests pass.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
Edited by Laurent Petre

Merge request reports