Improve the documentation in jointRetargeting.ini

robotology · May 13, 2020 · 5d0a4fd · 5d0a4fd
1 parent a9a2591
commit 5d0a4fd
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/...alkingModule/app/robots/iCubGazeboV2_5/dcm_walking/joint_retargeting/jointRetargeting.ini b/...alkingModule/app/robots/iCubGazeboV2_5/dcm_walking/joint_retargeting/jointRetargeting.ini
@@ -4,6 +4,10 @@ approaching_phase_duration      4.0
 
 
 [JOINT_RETARGETING]
+## List of the retargeting joint. This list must be the same or a subset of the
+## "joints_list" in robotControl.ini. The order of the joints should be choseen
+## accordingly to the order of the joints received in the
+## "joint_retargeting_port_name" port
 retargeting_joint_list          ("neck_pitch", "neck_roll", "neck_yaw",
                                  "torso_pitch", "torso_roll", "torso_yaw",
                                  "l_shoulder_pitch", "l_shoulder_roll", "l_shoulder_yaw", "l_elbow", "l_wrist_prosup",

diff --git a/src/WalkingModule/app/robots/iCubGenova04/dcm_walking/joint_retargeting/jointRetargeting.ini b/src/WalkingModule/app/robots/iCubGenova04/dcm_walking/joint_retargeting/jointRetargeting.ini
@@ -4,6 +4,10 @@ approaching_phase_duration      4.0
 
 
 [JOINT_RETARGETING]
+## List of the retargeting joint. This list must be the same or a subset of the
+## "joints_list" in robotControl.ini. The order of the joints should be choseen
+## accordingly to the order of the joints received in the
+## "joint_retargeting_port_name" port
 retargeting_joint_list          ("neck_pitch", "neck_roll", "neck_yaw",
                                  "torso_pitch", "torso_roll", "torso_yaw",
                                  "l_shoulder_pitch", "l_shoulder_roll", "l_shoulder_yaw", "l_elbow", "l_wrist_prosup",