Skip to content

Improve Doxygen documentation's readability

Marie Houillon requested to merge update_doc into master

What does this MR do?

This merge request proposes to modify the Doxygen documentation of carputils:

  • The section "namespaces" is now called "packages".
  • The scripts in the bin directory are now gathered together in the documentation, in a subcategory "bin".
  • The brief description of the scripts in bin now appears in the Doxygen documentation.

Below are some before/after screenshots illustrating the changes

Before After
Screenshot_2024-02-06_at_18.30.34 Screenshot_2024-02-06_at_18.30.13
Screenshot_2024-02-06_at_18.30.34 Screenshot_2024-02-06_at_18.30.47
Screenshot_2024-02-06_at_18.31.27 Screenshot_2024-02-06_at_18.31.15

Related issues

Closes #151 (closed)

Author's checklist

  • Follow the Contribution Guidelines.
  • Apply the appropriate labels.
  • Does this commit add new dependencies (e.g. Python modules)? If yes, please evaluate carefully if the additional dependency is a more sustainable option than including the functionality in own code. If the former, describe the dependency clearly, add them to the Software Management Plan and the installation instructions (*.md files, CMake files, Docker files etc.).

Reviewer's checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Contribution Guidelines.

Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

Maintainer

  • Review by assigned maintainer, who can always request/require the above reviews.
  • Ensure a release milestone is set.

Merge request reports