Issue 304 in rtm-ros-robotics: User document for hrpsys and hrpsys_ros_bridge is missing

[rtm-ros-...@googlecode.com]

Status: Accepted
Owner: iisaac.s...@gmail.com
Labels: Type-Enhancement Priority-Medium

New issue 304 by gm130s: User document for hrpsys and hrpsys_ros_bridge is
missing
http://code.google.com/p/rtm-ros-robotics/issues/detail?id=304

Related discussion https://github.com/start-jsk/hironx-package/issues/47
(private repo).

Someone in ROS community is also wondering
http://answers.ros.org/question/119346/using-ros-for-biped-motion-planning/?comment=122461#comment-122461.

--
You received this message because this project is configured to send all
issue notifications to this address.
You may adjust your notification preferences at:
https://code.google.com/hosting/settings

[rtm-ros-...@googlecode.com]

Updates:
Status: Started

Comment #1 on issue 304 by gm130s: User document for hrpsys and

hrpsys_ros_bridge is missing
http://code.google.com/p/rtm-ros-robotics/issues/detail?id=304

A current limitation that I'm aware of;

This may sound complicated but the majority part of hrpsys resides in its
upstream repository [1], and the repository that is used for
generating .deb binary [2] (let's call it a `development repository`) does
NOT contain any program files of hrpsys. Since the current doc job at ROS
buildfarm that nicely generates api doc info from available source files
does not draw api documentation from the files that are not available on
the development repo (#1), there's no way for api docs to be generated.

# You can see Code API page of hrpsys is blank as of today
http://docs.ros.org/hydro/api/hrpsys/html/

The workaround we've thought of so far is documented at [3]; meaning, add
methods in the client class that override the methods in the parent class
in hrpsys (HrpsysConfigurator).

[1] https://code.google.com/p/hrpsys-base/source/
[2]
https://code.google.com/p/rtm-ros-robotics/source/browse/#svn%2Ftrunk%2Fopenrtm_common%2Fhrpsys
[3] https://code.google.com/p/rtm-ros-robotics/issues/detail?id=225

#1. Maybe I just don't know how. If there's a way to specify in
CMakeLists.txt to draw api doc info from remote repository, it may be
possible.

Any better idea is welcomed!

[rtm-ros-...@googlecode.com]

Comment #2 on issue 304 by kei.ok...@gmail.com: User document for hrpsys

and hrpsys_ros_bridge is missing
http://code.google.com/p/rtm-ros-robotics/issues/detail?id=304

As for API docs for hrpsys, we can commit generated API docs to hrpsys-bsae
source repository or run jenkins to generate api docs. Then, we can add
link from docs.ros.org to commited/generated hrpsys doc API's URL.

[rtm-ros-...@googlecode.com]

Updates:
Status: Done

Comment #3 on issue 304 by iisaac.s...@gmail.com: User document for hrpsys
and hrpsys_ros_bridge is missing
https://code.google.com/p/rtm-ros-robotics/issues/detail?id=304

Done in https://github.com/fkanehiro/hrpsys-base/issues/268