Skip to content

Fix typos in Doxygen documentation#478

Merged
dcoeurjo merged 5 commits intomainfrom
copilot/fix-typos-in-doxygen-docs
Jan 15, 2026
Merged

Fix typos in Doxygen documentation#478
dcoeurjo merged 5 commits intomainfrom
copilot/fix-typos-in-doxygen-docs

Conversation

Copy link
Contributor

Copilot AI commented Jan 2, 2026

Corrects spelling errors in Doxygen comments and CLI help text across multiple cpp files.

Fixed typos:

  • the thethe (duplicate word)
  • usefulluseful
  • Integral InvarianIntegral Invariant
  • paramtericparametric
  • decribeddescribed

Files affected:

  • visualisation/3dCurveViewer.cpp, 3dCurvatureViewer.cpp, 3dCurvatureViewerNoise.cpp, 3dSDPViewer.cpp
  • volumetric/volShapeMetrics.cpp
  • estimators/lengthEstimators.cpp, volSurfaceRegularization.cpp

Documentation-only changes, no functional impact.

Original prompt

Can you create a pull-request to fix typos in the doxygen documentation of the cpp files?


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: dcoeurjo <700165+dcoeurjo@users.noreply.github.com>
Co-authored-by: dcoeurjo <700165+dcoeurjo@users.noreply.github.com>
@dcoeurjo dcoeurjo marked this pull request as ready for review January 2, 2026 19:35
Copilot AI changed the title [WIP] Fix typos in doxygen documentation of cpp files Fix typos in Doxygen documentation Jan 2, 2026
Copilot AI requested a review from dcoeurjo January 2, 2026 19:36
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes multiple spelling errors in Doxygen documentation across various C++ files in the DGtalTools project. The corrections improve documentation quality without affecting any code logic.

  • Corrects common spelling mistakes: "usefull" → "useful", "the the" → "the", "paramteric" → "parametric"
  • Fixes terminology: "Integral Invarian" → "Integral Invariant"
  • Fixes verb spelling: "decribed" → "described"

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.

Show a summary per file
File Description
volumetric/volShapeMetrics.cpp Corrects "usefull" to "useful" in app description
visualisation/3dSDPViewer.cpp Corrects "usefull" to "useful" in help text and command-line option description (2 occurrences)
visualisation/3dCurveViewer.cpp Removes duplicate "the the" in help text and command-line option description (2 occurrences)
visualisation/3dCurvatureViewerNoise.cpp Corrects "usefull" to "useful" in help text and command-line options (3 occurrences)
visualisation/3dCurvatureViewer.cpp Corrects "usefull" to "useful" (2 occurrences) and "Integral Invarian" to "Integral Invariant" in app description and command-line options
estimators/volSurfaceRegularization.cpp Corrects "decribed" to "described" in documentation comment
estimators/lengthEstimators.cpp Corrects "paramteric" to "parametric" in documentation brief

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@dcoeurjo dcoeurjo requested a review from kerautret January 2, 2026 20:30
Copy link
Member

@kerautret kerautret left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks !

@dcoeurjo dcoeurjo merged commit 5107af0 into main Jan 15, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants