Yarp: Update yarpmotorgui documentation
The yarpmotorgui documentation available at https://github.com/robotology/yarp/blob/75a62fa0756ae6fade7916d9016bcb832ff9aebb/doc/cmd_yarpmotorgui.dox should be updated to match the latest version of the yarpmotorgui .
Bonus points for documenting the changes in the configuration files in the ChangeLog https://github.com/robotology/yarp/blob/devel/doc/release/v2_3_70.md#yarpmotorgui .
See https://github.com/robotology/yarp/issues/1087#issuecomment-280677006 .
traversaro
All 9 comments
cc @fiorisi .
traversaro
on 21 Feb 2017
http://www.yarp.it/yarpmotorgui.html should reflect the status of branch master, and not devel, I think... Any idea about how to handle this issue (different documentation between master and devel branch)?
randaz81
on 22 Feb 2017
http://www.yarp.it/yarpmotorgui.html should reflect the status of branch master, and not devel, I think...
Yes, I removed the reference to that page from the issue.
Any idea about how to handle this issue (different documentation between master and devel branch)?
The proper way is using doxygen to generate documentation for each version. Quoting @drdanz from http://wiki.icub.org/wiki/YARP_Cleanup#Other_Optional_Cleanup :
Instead of just the latest documentation at http://eris.liralab.it/yarpdoc/index.html , we should have it for each version (for example http://eris.liralab.it/yarpdoc/2.3.19/index.html)
As an example, see https://cmake.org/cmake/help/git-master/index.html and the nice version choice menu up on the left.
traversaro
on 22 Feb 2017
I'd also point to: http://wiki.icub.org/wiki/Force_Control#Available_control_modes
which has a great colorful description on control modes I'm not sure is available elsewhere.
Updates should include some info on interaction modes which are present in newer yarpmotorgui versions.
jgvictores
on 28 Feb 2017
馃憤 For @traversaro proposal about the versioned documentation.
Unfortunately I asked for that already thousands of times...
drdanz
on 10 Mar 2017
traversaro
on 31 Mar 2017
Related: #1139
jgvictores
on 17 May 2017
The documentation is now versioned:
master: http://www.yarp.it/devel: http://www.yarp.it/devel/
traversaro
on 7 Nov 2017
Updates should include some info on interaction modes which are present in newer yarpmotorgui versions.
Some documentation of Interaction Modes at: http://wiki.icub.org/wiki/Control_Modes
jgvictores
on 22 Apr 2019
Related issues
S-Dafarra
路
3Comments
CarlottaSartore
路
3Comments
traversaro
路
3Comments
diegoferigo
路
3Comments
traversaro
路
3Comments
Most helpful comment
Yes, I removed the reference to that page from the issue.
The proper way is using doxygen to generate documentation for each version. Quoting @drdanz from http://wiki.icub.org/wiki/YARP_Cleanup#Other_Optional_Cleanup :
As an example, see https://cmake.org/cmake/help/git-master/index.html and the nice version choice menu up on the left.