Skip to content

Add doxygen-compliant documentation based on the MATLAB docs. - #74

Merged
mmmarinho merged 25 commits into
masterfrom
improve-docs
Sep 21, 2026
Merged

Add doxygen-compliant documentation based on the MATLAB docs.#74
mmmarinho merged 25 commits into
masterfrom
improve-docs

Conversation

@mmmarinho

@mmmarinho mmmarinho commented Sep 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Documenting the public API in a doxygen compliant manner.

Note: The cpp-examples repository has been adjusted so that the macOS and windows builds pass. The issues have nothing to do with the documentation:

@mmmarinho
mmmarinho requested a review from juanjqo September 4, 2026 08:57
@mmmarinho mmmarinho self-assigned this Sep 4, 2026
@mmmarinho
mmmarinho marked this pull request as ready for review September 4, 2026 09:46
@mmmarinho mmmarinho mentioned this pull request Sep 4, 2026
Merged
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_KinematicConstrainedController.h
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_KinematicConstrainedController.h
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_KinematicController.h Outdated
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_KinematicController.h Outdated
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_KinematicController.h Outdated
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_KinematicController.h Outdated
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_NumericalFilteredPseudoInverseController.h Outdated
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/utils/DQ_Geometry.h Outdated
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_PseudoinverseController.h Outdated
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_PseudoinverseController.h Outdated
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_PseudoinverseController.h Outdated
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_PseudoinverseController.h Outdated
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_QuadraticProgrammingController.h Outdated
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_QuadraticProgrammingController.h Outdated
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_QuadraticProgrammingController.h Outdated
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_QuadraticProgrammingController.h Outdated
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_QuadraticProgrammingController.h Outdated
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_QuadraticProgrammingController.h Outdated
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_modeling/DQ_SerialManipulator.h
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_modeling/DQ_SerialManipulator.h
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_modeling/DQ_SerialManipulator.h
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_modeling/DQ_SerialManipulator.h
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_modeling/DQ_SerialManipulator.h
juanjqo
juanjqo reviewed Sep 20, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_modeling/DQ_SerialManipulator.h
juanjqo
juanjqo requested changes Sep 20, 2026
View reviewed changes

@juanjqo juanjqo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hi @mmmarinho,

I just left some minor comments and some suggestions.

Kind regards,

Juancho

mmmarinho and others added 21 commits September 21, 2026 04:33
@mmmarinho @juanjqo
Update include/dqrobotics/robot_control/DQ_KinematicController.h
0ad9f65 
Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_control/DQ_NumericalFilteredPseudoInv…
544fc04 
…erseController.h

Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_control/DQ_PseudoinverseController.h
7bea650 
Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/utils/DQ_Geometry.h
62d8373 
Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_control/DQ_PseudoinverseController.h
49e1d86 
Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_control/DQ_PseudoinverseController.h
f6d9b02 
Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_control/DQ_QuadraticProgrammingContro…
16fe754 
…ller.h

Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_control/DQ_QuadraticProgrammingContro…
19d3d73 
…ller.h

Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_control/DQ_QuadraticProgrammingContro…
9ead76e 
…ller.h

Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_control/DQ_KinematicController.h
69b9a32 
Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_control/DQ_KinematicController.h
f327684 
Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_control/DQ_PseudoinverseController.h
20ba6f6 
Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_control/DQ_QuadraticProgrammingContro…
e65f8c4 
…ller.h

Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_control/DQ_QuadraticProgrammingContro…
9fa362f 
…ller.h

Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_control/DQ_QuadraticProgrammingContro…
3c58995 
…ller.h

Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_modeling/DQ_SerialManipulator.h
514deb0 
Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_modeling/DQ_SerialManipulator.h
eb780f8 
Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_modeling/DQ_SerialManipulator.h
4d2551a 
Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_modeling/DQ_SerialManipulator.h
7abe224 
Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_modeling/DQ_SerialManipulator.h
2e53e3b 
Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_modeling/DQ_SerialManipulator.h
c2370ec 
Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
juanjqo
juanjqo reviewed Sep 21, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_KinematicConstrainedController.h
juanjqo
juanjqo reviewed Sep 21, 2026
View reviewed changes
Comment thread include/dqrobotics/robot_control/DQ_KinematicConstrainedController.h
juanjqo
juanjqo requested changes Sep 21, 2026
View reviewed changes

@juanjqo juanjqo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@mmmarinho, I include the two comments you mentioned as suggestions.

Kind regards,

Juancho

mmmarinho and others added 2 commits September 21, 2026 09:54
@mmmarinho @juanjqo
Update include/dqrobotics/robot_control/DQ_KinematicConstrainedContro…
5f94e0d 
…ller.h

Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho @juanjqo
Update include/dqrobotics/robot_control/DQ_KinematicConstrainedContro…
b747b4e 
…ller.h

Co-authored-by: Juan José Quiroz Omaña <juanjqogm@gmail.com>
@mmmarinho

mmmarinho commented Sep 21, 2026

Copy link
Copy Markdown
Member Author

@juanjqo All done, when you approve we can squash and merge.

@mmmarinho
mmmarinho merged commit d4fd283 into master Sep 21, 2026
6 of 12 checks passed
@mmmarinho
mmmarinho deleted the improve-docs branch September 21, 2026 10:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@juanjqo juanjqo juanjqo approved these changes

Assignees

@mmmarinho mmmarinho

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mmmarinho @juanjqo