From 1720532942a2c07ce3558b2eca203d52f633f7ec Mon Sep 17 00:00:00 2001 From: Alexandre Vannobel <41082816+alexvannobel@users.noreply.github.com> Date: Fri, 1 Nov 2019 08:14:27 -0400 Subject: [PATCH] Add "Client" to auto-generated documentation for RPCs (#32) * Added missing OnNotification functions in documentation * Add 'Client' to autogenerated documentation --- api_cpp/doc/markdown/summary_pages/ActuatorConfig.md | 2 +- api_cpp/doc/markdown/summary_pages/ActuatorCyclic.md | 2 +- api_cpp/doc/markdown/summary_pages/Base.md | 2 +- api_cpp/doc/markdown/summary_pages/BaseCyclic.md | 2 +- api_cpp/doc/markdown/summary_pages/ControlConfig.md | 2 +- api_cpp/doc/markdown/summary_pages/DeviceConfig.md | 2 +- api_cpp/doc/markdown/summary_pages/DeviceManager.md | 2 +- api_cpp/doc/markdown/summary_pages/GripperCyclic.md | 2 +- api_cpp/doc/markdown/summary_pages/InterconnectConfig.md | 2 +- api_cpp/doc/markdown/summary_pages/InterconnectCyclic.md | 2 +- api_cpp/doc/markdown/summary_pages/Session.md | 2 +- api_cpp/doc/markdown/summary_pages/VisionConfig.md | 2 +- api_python/doc/markdown/summary_pages/ActuatorConfig.md | 2 +- api_python/doc/markdown/summary_pages/ActuatorCyclic.md | 2 +- api_python/doc/markdown/summary_pages/Base.md | 2 +- api_python/doc/markdown/summary_pages/BaseCyclic.md | 2 +- api_python/doc/markdown/summary_pages/ControlConfig.md | 2 +- api_python/doc/markdown/summary_pages/DeviceConfig.md | 2 +- api_python/doc/markdown/summary_pages/DeviceManager.md | 2 +- api_python/doc/markdown/summary_pages/GripperCyclic.md | 2 +- api_python/doc/markdown/summary_pages/InterconnectConfig.md | 2 +- api_python/doc/markdown/summary_pages/InterconnectCyclic.md | 2 +- api_python/doc/markdown/summary_pages/Session.md | 2 +- api_python/doc/markdown/summary_pages/VisionConfig.md | 2 +- 24 files changed, 24 insertions(+), 24 deletions(-) diff --git a/api_cpp/doc/markdown/summary_pages/ActuatorConfig.md b/api_cpp/doc/markdown/summary_pages/ActuatorConfig.md index 7c06c120..9dead241 100644 --- a/api_cpp/doc/markdown/summary_pages/ActuatorConfig.md +++ b/api_cpp/doc/markdown/summary_pages/ActuatorConfig.md @@ -42,7 +42,7 @@ This section describes the data classes used in this API, as well as their membe Service to configure actuators - **Services** + **ActuatorConfigClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_cpp/doc/markdown/summary_pages/ActuatorCyclic.md b/api_cpp/doc/markdown/summary_pages/ActuatorCyclic.md index adaee8f4..0f6c7cd9 100644 --- a/api_cpp/doc/markdown/summary_pages/ActuatorCyclic.md +++ b/api_cpp/doc/markdown/summary_pages/ActuatorCyclic.md @@ -25,7 +25,7 @@ This section describes the data classes used in this API, as well as their membe Service to exchange cyclic data with an actuator - **Services** + **ActuatorCyclicClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_cpp/doc/markdown/summary_pages/Base.md b/api_cpp/doc/markdown/summary_pages/Base.md index fe167bc4..b47cdfb2 100644 --- a/api_cpp/doc/markdown/summary_pages/Base.md +++ b/api_cpp/doc/markdown/summary_pages/Base.md @@ -204,7 +204,7 @@ This section describes the data classes used in this API, as well as their membe Base service. Broadly useful service. Provides functions for configuring a range of base-related functionalities and for enabling high-level control for the robot. - **Services** + **BaseClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_cpp/doc/markdown/summary_pages/BaseCyclic.md b/api_cpp/doc/markdown/summary_pages/BaseCyclic.md index e8010d58..ce9ef040 100644 --- a/api_cpp/doc/markdown/summary_pages/BaseCyclic.md +++ b/api_cpp/doc/markdown/summary_pages/BaseCyclic.md @@ -26,7 +26,7 @@ This section describes the data classes used in this API, as well as their membe Service to exchange cyclic data with base - **Services** + **BaseCyclicClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_cpp/doc/markdown/summary_pages/ControlConfig.md b/api_cpp/doc/markdown/summary_pages/ControlConfig.md index c65ffd87..76eae796 100644 --- a/api_cpp/doc/markdown/summary_pages/ControlConfig.md +++ b/api_cpp/doc/markdown/summary_pages/ControlConfig.md @@ -27,7 +27,7 @@ This section describes the data classes used in this API, as well as their membe Service to configure robot control library - **Services** + **ControlConfigClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_cpp/doc/markdown/summary_pages/DeviceConfig.md b/api_cpp/doc/markdown/summary_pages/DeviceConfig.md index 3015a1bf..9d5c9015 100644 --- a/api_cpp/doc/markdown/summary_pages/DeviceConfig.md +++ b/api_cpp/doc/markdown/summary_pages/DeviceConfig.md @@ -49,7 +49,7 @@ This section describes the data classes used in this API, as well as their membe Service to get and set device configuration information - **Services** + **DeviceConfigClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_cpp/doc/markdown/summary_pages/DeviceManager.md b/api_cpp/doc/markdown/summary_pages/DeviceManager.md index d108c141..13bfaa9d 100644 --- a/api_cpp/doc/markdown/summary_pages/DeviceManager.md +++ b/api_cpp/doc/markdown/summary_pages/DeviceManager.md @@ -20,7 +20,7 @@ This section describes the data classes used in this API, as well as their membe This service provides information about which devices are present in the robot - **Services** + **DeviceManagerClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_cpp/doc/markdown/summary_pages/GripperCyclic.md b/api_cpp/doc/markdown/summary_pages/GripperCyclic.md index d2666527..f914d2bb 100644 --- a/api_cpp/doc/markdown/summary_pages/GripperCyclic.md +++ b/api_cpp/doc/markdown/summary_pages/GripperCyclic.md @@ -26,7 +26,7 @@ This section describes the data classes used in this API, as well as their membe Service to exchange cyclic data with gripper - **Services** + **GripperCyclicClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_cpp/doc/markdown/summary_pages/InterconnectConfig.md b/api_cpp/doc/markdown/summary_pages/InterconnectConfig.md index 9a33c485..ee853603 100644 --- a/api_cpp/doc/markdown/summary_pages/InterconnectConfig.md +++ b/api_cpp/doc/markdown/summary_pages/InterconnectConfig.md @@ -44,7 +44,7 @@ This section describes the data classes used in this API, as well as their membe Service to get and set interface module \(interconnect\) configuration information, including user expansion - **Services** + **InterconnectConfigClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_cpp/doc/markdown/summary_pages/InterconnectCyclic.md b/api_cpp/doc/markdown/summary_pages/InterconnectCyclic.md index 336933c5..284c3042 100644 --- a/api_cpp/doc/markdown/summary_pages/InterconnectCyclic.md +++ b/api_cpp/doc/markdown/summary_pages/InterconnectCyclic.md @@ -23,7 +23,7 @@ This section describes the data classes used in this API, as well as their membe Service to exchange cyclic data with interface module - **Services** + **InterconnectCyclicClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_cpp/doc/markdown/summary_pages/Session.md b/api_cpp/doc/markdown/summary_pages/Session.md index ab8fad1f..a592f444 100644 --- a/api_cpp/doc/markdown/summary_pages/Session.md +++ b/api_cpp/doc/markdown/summary_pages/Session.md @@ -21,7 +21,7 @@ This section describes the data classes used in this API, as well as their membe Service to manage user sessions - **Services** + **SessionClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_cpp/doc/markdown/summary_pages/VisionConfig.md b/api_cpp/doc/markdown/summary_pages/VisionConfig.md index cd5b6453..d110bb8c 100644 --- a/api_cpp/doc/markdown/summary_pages/VisionConfig.md +++ b/api_cpp/doc/markdown/summary_pages/VisionConfig.md @@ -42,7 +42,7 @@ This section describes the data classes used in this API, as well as their membe Service to configure the Vision Module - **Services** + **VisionConfigClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_python/doc/markdown/summary_pages/ActuatorConfig.md b/api_python/doc/markdown/summary_pages/ActuatorConfig.md index 409ebed7..f0694e40 100644 --- a/api_python/doc/markdown/summary_pages/ActuatorConfig.md +++ b/api_python/doc/markdown/summary_pages/ActuatorConfig.md @@ -42,7 +42,7 @@ This section describes the data classes used in this API, as well as their membe Service to configure actuators - **Services** + **ActuatorConfigClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_python/doc/markdown/summary_pages/ActuatorCyclic.md b/api_python/doc/markdown/summary_pages/ActuatorCyclic.md index 7ac34a91..46fc2959 100644 --- a/api_python/doc/markdown/summary_pages/ActuatorCyclic.md +++ b/api_python/doc/markdown/summary_pages/ActuatorCyclic.md @@ -25,7 +25,7 @@ This section describes the data classes used in this API, as well as their membe Service to exchange cyclic data with an actuator - **Services** + **ActuatorCyclicClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_python/doc/markdown/summary_pages/Base.md b/api_python/doc/markdown/summary_pages/Base.md index 050f9d2a..26ec8bb0 100644 --- a/api_python/doc/markdown/summary_pages/Base.md +++ b/api_python/doc/markdown/summary_pages/Base.md @@ -204,7 +204,7 @@ This section describes the data classes used in this API, as well as their membe Base service. Broadly useful service. Provides functions for configuring a range of base-related functionalities and for enabling high-level control for the robot. - **Services** + **BaseClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_python/doc/markdown/summary_pages/BaseCyclic.md b/api_python/doc/markdown/summary_pages/BaseCyclic.md index 5e9086af..92392470 100644 --- a/api_python/doc/markdown/summary_pages/BaseCyclic.md +++ b/api_python/doc/markdown/summary_pages/BaseCyclic.md @@ -26,7 +26,7 @@ This section describes the data classes used in this API, as well as their membe Service to exchange cyclic data with base - **Services** + **BaseCyclicClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_python/doc/markdown/summary_pages/ControlConfig.md b/api_python/doc/markdown/summary_pages/ControlConfig.md index c8938e4c..f3207094 100644 --- a/api_python/doc/markdown/summary_pages/ControlConfig.md +++ b/api_python/doc/markdown/summary_pages/ControlConfig.md @@ -27,7 +27,7 @@ This section describes the data classes used in this API, as well as their membe Service to configure robot control library - **Services** + **ControlConfigClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_python/doc/markdown/summary_pages/DeviceConfig.md b/api_python/doc/markdown/summary_pages/DeviceConfig.md index 1384fb61..60411df8 100644 --- a/api_python/doc/markdown/summary_pages/DeviceConfig.md +++ b/api_python/doc/markdown/summary_pages/DeviceConfig.md @@ -49,7 +49,7 @@ This section describes the data classes used in this API, as well as their membe Service to get and set device configuration information - **Services** + **DeviceConfigClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_python/doc/markdown/summary_pages/DeviceManager.md b/api_python/doc/markdown/summary_pages/DeviceManager.md index f11fb689..7756ac3a 100644 --- a/api_python/doc/markdown/summary_pages/DeviceManager.md +++ b/api_python/doc/markdown/summary_pages/DeviceManager.md @@ -20,7 +20,7 @@ This section describes the data classes used in this API, as well as their membe This service provides information about which devices are present in the robot - **Services** + **DeviceManagerClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_python/doc/markdown/summary_pages/GripperCyclic.md b/api_python/doc/markdown/summary_pages/GripperCyclic.md index 0feb1c1a..bc7df868 100644 --- a/api_python/doc/markdown/summary_pages/GripperCyclic.md +++ b/api_python/doc/markdown/summary_pages/GripperCyclic.md @@ -26,7 +26,7 @@ This section describes the data classes used in this API, as well as their membe Service to exchange cyclic data with gripper - **Services** + **GripperCyclicClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_python/doc/markdown/summary_pages/InterconnectConfig.md b/api_python/doc/markdown/summary_pages/InterconnectConfig.md index 7edba0ae..56af4139 100644 --- a/api_python/doc/markdown/summary_pages/InterconnectConfig.md +++ b/api_python/doc/markdown/summary_pages/InterconnectConfig.md @@ -44,7 +44,7 @@ This section describes the data classes used in this API, as well as their membe Service to get and set interface module \(interconnect\) configuration information, including user expansion - **Services** + **InterconnectConfigClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_python/doc/markdown/summary_pages/InterconnectCyclic.md b/api_python/doc/markdown/summary_pages/InterconnectCyclic.md index 0673473d..19851767 100644 --- a/api_python/doc/markdown/summary_pages/InterconnectCyclic.md +++ b/api_python/doc/markdown/summary_pages/InterconnectCyclic.md @@ -23,7 +23,7 @@ This section describes the data classes used in this API, as well as their membe Service to exchange cyclic data with interface module - **Services** + **InterconnectCyclicClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_python/doc/markdown/summary_pages/Session.md b/api_python/doc/markdown/summary_pages/Session.md index 153e31be..bc61c6db 100644 --- a/api_python/doc/markdown/summary_pages/Session.md +++ b/api_python/doc/markdown/summary_pages/Session.md @@ -21,7 +21,7 @@ This section describes the data classes used in this API, as well as their membe Service to manage user sessions - **Services** + **SessionClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------| diff --git a/api_python/doc/markdown/summary_pages/VisionConfig.md b/api_python/doc/markdown/summary_pages/VisionConfig.md index 8681f228..2ef08043 100644 --- a/api_python/doc/markdown/summary_pages/VisionConfig.md +++ b/api_python/doc/markdown/summary_pages/VisionConfig.md @@ -42,7 +42,7 @@ This section describes the data classes used in this API, as well as their membe Service to configure the Vision Module - **Services** + **VisionConfigClient RPCs** |Function name|Return type|Input type|Description| |-------------|-----------|----------|-----------|