search

start-jsk / rtmros_common

OpenRTM - ROS interoperability packages
http://wiki.ros.org/rtmros_common
12 stars 52 forks source link

(ROS .deb) api doc of openrtm_aist, openhrp3 are not auto-generated by ROS doxygen #223

Closed k-okada closed 10 years ago

k-okada commented 10 years ago

From gm130s on October 10, 2013 20:51:11

For example, a user asks api info about hiro.setTargetPose. https://groups.google.com/d/msg/rtm-ros-robotics/zMymehyT45I/gbdOS2SHgs4J That method is inherited from hrpsys_config, of which API doc isn't generated automatically by ROS doc server (because its code is only downloaded upon build-time).

Original issue: http://code.google.com/p/rtm-ros-robotics/issues/detail?id=225

k-okada commented 10 years ago

From gm130s on October 10, 2013 04:59:25

A possible, cumbersome, workaround would be to inherit in derived classes all methods that are beneficial to be documented, and call the parent method but put API document there.

Example (grammar might be wrong):

def setTargetPose(self, a, b, c):
    '''
    foobar api doc comes here.
    '''
    super().setTargetPose(a, b, c)

Obvious drawback is that each method in all subclasses can declare different API doc (let alone behavior).

k-okada commented 10 years ago

From gm130s on December 19, 2013 14:54:21

Escalating priority due to a request from one of the core users.

I will implement the workaround mentioned in #1 (cited below) to hironx_ros_bridge/src/hironx_ros_bridge/hironx_client.py.

A possible, cumbersome, workaround would be to inherit in derived classes all methods that are beneficial to be documented, and call the parent method but put API document there. 

Example (grammar might be wrong):

    def setTargetPose(self, a, b, c):
        '''
        foobar api doc comes here.
        '''
        super().setTargetPose(a, b, c)

Obvious drawback is that each method in all subclasses can declare different API doc (let alone behavior). http://docs.ros.org/hydro/api/hironx_ros_bridge/html/classhironx__ros__bridge_1_1hironx__client_1_1HIRONX.html

Status: Accepted
Labels: -Priority-Low Priority-High

k-okada commented 10 years ago

From gm130s on January 27, 2014 21:24:54

Limiting this ticket to openrtm_aist_core and openhrp3 only now that docs for hrpsys is ported to http://code.google.com/p/rtm-ros-robotics/issues/detail?id=304#c1

Summary: (ROS .deb) api doc of openrtm_aist, openhrp3 are not auto-generated by ROS doxygen (was: (ROS .deb) api doc of openrtm_aist, openhrp3, hrpsys are not auto-generated by ROS doxygen)
Owner: iisaac.s...@gmail.com
Labels: -Priority-High Priority-Low