Skip to content

Commit 706edcf

Browse files
committed
algorithm/utils : some doc cleanup
1 parent 33f8064 commit 706edcf

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

include/pinocchio/algorithm/utils/force.hpp

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,14 @@
1212
namespace pinocchio
1313
{
1414
///
15-
/// @copydoc changeReferenceFrame(const SE3Tpl<Scalar,Options> &,const ForceDense<MotionIn>
16-
/// &,const ReferenceFrame,const ReferenceFrame) \param[out] f_out Resulting force quantity.
15+
/// \copybrief changeReferenceFrame(const SE3Tpl<Scalar,Options> &,const ForceDense<ForceIn>
16+
/// &,const ReferenceFrame,const ReferenceFrame)
17+
///
18+
/// \param[in] placement Placement of the frame having force f_in
19+
/// \param[in] f_in Input force quantity.
20+
/// \param[in] rf_in Reference frame in which m_in is expressed
21+
/// \param[in] rf_out Reference frame in which the result m_out is expressed
22+
/// \param[out] f_out Resulting force quantity.
1723
///
1824
template<typename Scalar, int Options, typename ForceIn, typename ForceOut>
1925
void changeReferenceFrame(
@@ -84,7 +90,7 @@ namespace pinocchio
8490
/// \param[in] f_in Input force quantity.
8591
/// \param[in] rf_in Reference frame in which m_in is expressed
8692
/// \param[in] rf_out Reference frame in which the result m_out is expressed
87-
/// \param[out] f_out Resulting force quantity.
93+
/// \return Resulting force quantity.
8894
///
8995
template<typename Scalar, int Options, typename ForceIn>
9096
typename ForceIn::ForcePlain changeReferenceFrame(

include/pinocchio/algorithm/utils/motion.hpp

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,13 @@ namespace pinocchio
1313
{
1414

1515
///
16-
/// @copydoc changeReferenceFrame(const SE3Tpl<Scalar,Options> &,const MotionDense<MotionIn>
16+
/// \copybrief changeReferenceFrame(const SE3Tpl<Scalar,Options> &,const MotionDense<MotionIn>
1717
/// &,const ReferenceFrame,const ReferenceFrame)
18+
///
19+
/// \param[in] placement Placement of the frame having velocity m_in
20+
/// \param[in] m_in Input motion quantity.
21+
/// \param[in] rf_in Reference frame in which m_in is expressed
22+
/// \param[in] rf_out Reference frame in which the result m_out is expressed
1823
/// \param[out] m_out Resulting motion quantity.
1924
///
2025
template<typename Scalar, int Options, typename MotionIn, typename MotionOut>
@@ -86,7 +91,7 @@ namespace pinocchio
8691
/// \param[in] m_in Input motion quantity.
8792
/// \param[in] rf_in Reference frame in which m_in is expressed
8893
/// \param[in] rf_out Reference frame in which the result m_out is expressed
89-
/// \param[out] m_out Resulting motion quantity.
94+
/// \return Resulting motion quantity.
9095
///
9196
template<typename Scalar, int Options, typename MotionIn>
9297
typename MotionIn::MotionPlain changeReferenceFrame(

0 commit comments

Comments
 (0)