[WIP] Squash doxygen errors. #357

sniyaz · 2018-03-02T22:37:54Z

This mainly involved fixing some doc-strings and renaming parameters.

TODO: I had some trouble squashing the warnings involving SplineTrajectory-impl.hpp. @jslee02 and other people who know doxygen better, could take a look? There doesn't appear to be an documentation in that file at all, so I'm confused 😖

Before creating a pull request

Document new methods and classes
Format code with make format

Before merging a pull request

Set version target by selecting a milestone on the right side
Summarize this change in CHANGELOG.md
Add unit test(s) for this change

…nto sniyaz/doxygen Conflicts: include/aikido/constraint/dart/CollisionFree.hpp include/aikido/planner/TrajectoryPostProcessor.hpp

codecov · 2018-03-02T23:00:57Z

Codecov Report

Merging #357 into master will increase coverage by 0.01%.
The diff coverage is 50%.

@@            Coverage Diff             @@
##           master     #357      +/-   ##
==========================================
+ Coverage   80.98%   80.99%   +0.01%     
==========================================
  Files         206      206              
  Lines        6036     6036              
==========================================
+ Hits         4888     4889       +1     
+ Misses       1148     1147       -1

Impacted Files	Coverage Δ
include/aikido/statespace/GeodesicInterpolator.hpp	`100% <ø> (ø)`	⬆️
...nclude/aikido/planner/ompl/GeometricStateSpace.hpp	`100% <ø> (ø)`	⬆️
include/aikido/statespace/SO3.hpp	`100% <ø> (ø)`	⬆️
include/aikido/statespace/CartesianProduct.hpp	`100% <ø> (ø)`	⬆️
include/aikido/constraint/Satisfied.hpp	`100% <ø> (ø)`	⬆️
include/aikido/statespace/dart/RnJoint.hpp	`100% <ø> (ø)`	⬆️
include/aikido/statespace/detail/SO3-impl.hpp	`100% <ø> (ø)`	⬆️
include/aikido/common/Spline.hpp	`100% <ø> (ø)`	⬆️
include/aikido/statespace/StateSpace.hpp	`100% <ø> (ø)`	⬆️
include/aikido/constraint/dart/CollisionFree.hpp	`100% <ø> (ø)`	⬆️
... and 22 more

sniyaz · 2018-03-03T00:10:15Z

Hang on, flipped something. Will fix to satisfy Travis.

jslee02

Thanks for the fixes! Left a few suggestions.

jslee02 · 2018-03-03T00:06:42Z

include/aikido/constraint/dart/CollisionFree.hpp

-  /// \param group Collision group.
-  void addSelfCheck(std::shared_ptr<::dart::collision::CollisionGroup> _group);
+  /// \param _group Collision group.
+  void addSelfCheck(std::shared_ptr<dart::collision::CollisionGroup> _group);


Nit: Was this one of the reasons of the Doxygen warnings? We used global namespace resolutions for dart (i.e., ::dart) to avoid conflicts with ::aikido::constraint::dart. It might be good to leave it as it was if it's not a cause of the warnings.

Probably this is the reason for the CI fails.

jslee02 · 2018-03-03T00:06:50Z

include/aikido/constraint/dart/CollisionFree.hpp

-  void removeSelfCheck(
-      std::shared_ptr<::dart::collision::CollisionGroup> _group);
+  /// \param _group Collision group.
+  void removeSelfCheck(std::shared_ptr<dart::collision::CollisionGroup> _group);


Nit: Was this one of the reasons of the Doxygen warnings? We used global namespace resolutions for dart (i.e., ::dart) to avoid conflicts with ::aikido::constraint::dart. It might be good to leave it as it was if it's not a cause of the warnings.

jslee02 · 2018-03-03T00:47:44Z

include/aikido/statespace/detail/SO3-impl.hpp

@@ -31,7 +31,6 @@ class SO3StateHandle : public statespace::StateHandle<SO3, _QualifiedState>

  /// Constructs a point in SO(3) from a unit quaternion.
  ///


Nit: Could you remove this empty line as well?

sniyaz · 2018-03-05T19:55:26Z

I've squashed some errors from the Robot API and deleted SplineTrajectory-impl.hpp. Should be good to go now. Please rubber stamp when you have the chance 😄

jslee02

Looks good to me. Thanks for this work!

brianhou · 2018-03-05T22:00:19Z

include/aikido/control/BarrettFingerKinematicSimulationPositionCommandExecutor.hpp

@@ -82,8 +82,10 @@ class BarrettFingerKinematicSimulationPositionCommandExecutor
  /// is reached, or collision is detected.
  void step(const std::chrono::system_clock::time_point& timepoint) override;

-  /// \copydoc


Let's figure out how to fix this so we don't need to duplicate the \copydocs.

…aikido into sniyaz/doxygen

jslee02 · 2018-03-05T22:13:20Z

include/aikido/control/BarrettFingerKinematicSimulationPositionCommandExecutor.hpp

-  ///
-  /// \param collideWith CollisionGroup to check finger collisions
-  /// \return false if collideWith cannot be set (during execution)
+  /* clang-format off */


Nit: Could we use // clang-format off (C++ style) instead of /* clang-format off */ (C style)?

sniyaz · 2018-03-05T22:15:36Z

@brianhou I tried to look up ways to turn break the copydoc into multiple lines, but the only solution seems to manually turning clang format on/off 😢

* Move constraint to postprocess call, need to fix tests still. * Squished about half of warnings. * Squash most errors. * Fix test_SmoothPostProcessor. * Fix build, respond to nits. * Remove wierd -impl.hpp file that was never used. * Clean up doxygen errors from Robot API. * Update CHANGELOG. * Update CHANGELOG.md * Put copydoc back in, turn off clang format. * Change clang format comments to C++ style.

evil-sherdil added 5 commits February 20, 2018 01:54

Move constraint to postprocess call, need to fix tests still.

610713c

Squished about half of warnings.

0de8c8d

Squash most errors.

ed74c47

Fix test_SmoothPostProcessor.

0f3b331

Merge branch 'master' of https://github.com/personalrobotics/aikido i…

decbe7f

…nto sniyaz/doxygen Conflicts: include/aikido/constraint/dart/CollisionFree.hpp include/aikido/planner/TrajectoryPostProcessor.hpp

sniyaz requested review from brianhou and jslee02 March 2, 2018 22:39

jslee02 reviewed Mar 3, 2018

View reviewed changes

evil-sherdil added 2 commits March 5, 2018 14:30

Fix build, respond to nits.

dc0221c

Remove wierd -impl.hpp file that was never used.

ceff842

sniyaz added this to the Aikido 0.3.0 milestone Mar 5, 2018

evil-sherdil added 2 commits March 5, 2018 14:48

Clean up doxygen errors from Robot API.

5287774

Update CHANGELOG.

3850ab4

Update CHANGELOG.md

0ce3d3c

jslee02 approved these changes Mar 5, 2018

View reviewed changes

brianhou suggested changes Mar 5, 2018

View reviewed changes

evil-sherdil added 2 commits March 5, 2018 17:08

Put copydoc back in, turn off clang format.

2743d5c

Merge branch 'sniyaz/doxygen' of https://github.com/personalrobotics/…

08cba6c

…aikido into sniyaz/doxygen

jslee02 reviewed Mar 5, 2018

View reviewed changes

Change clang format comments to C++ style.

db8879c

brianhou approved these changes Mar 5, 2018

View reviewed changes

brianhou merged commit 7d83f5a into master Mar 5, 2018

brianhou deleted the sniyaz/doxygen branch March 5, 2018 23:42

brianhou mentioned this pull request Mar 5, 2018

Warnings from Doxygen #329

Closed

brianhou mentioned this pull request May 9, 2018

Fix documentation typo. #406

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Squash doxygen errors. #357

[WIP] Squash doxygen errors. #357

sniyaz commented Mar 2, 2018 •

edited

Loading

codecov bot commented Mar 2, 2018 •

edited

Loading

sniyaz commented Mar 3, 2018

jslee02 left a comment

jslee02 Mar 3, 2018 •

edited

Loading

jslee02 Mar 3, 2018

jslee02 Mar 3, 2018

sniyaz commented Mar 5, 2018

jslee02 left a comment

brianhou Mar 5, 2018

jslee02 Mar 5, 2018

sniyaz commented Mar 5, 2018

		@@ -31,7 +31,6 @@ class SO3StateHandle : public statespace::StateHandle<SO3, _QualifiedState>

		/// Constructs a point in SO(3) from a unit quaternion.
		///

[WIP] Squash doxygen errors. #357

[WIP] Squash doxygen errors. #357

Conversation

sniyaz commented Mar 2, 2018 • edited Loading

codecov bot commented Mar 2, 2018 • edited Loading

Codecov Report

sniyaz commented Mar 3, 2018

jslee02 left a comment

Choose a reason for hiding this comment

jslee02 Mar 3, 2018 • edited Loading

Choose a reason for hiding this comment

jslee02 Mar 3, 2018

Choose a reason for hiding this comment

jslee02 Mar 3, 2018

Choose a reason for hiding this comment

sniyaz commented Mar 5, 2018

jslee02 left a comment

Choose a reason for hiding this comment

brianhou Mar 5, 2018

Choose a reason for hiding this comment

jslee02 Mar 5, 2018

Choose a reason for hiding this comment

sniyaz commented Mar 5, 2018

sniyaz commented Mar 2, 2018 •

edited

Loading

codecov bot commented Mar 2, 2018 •

edited

Loading

jslee02 Mar 3, 2018 •

edited

Loading