Skip to content

Commit

Permalink
Add "Client" to auto-generated documentation for RPCs (#32)
Browse files Browse the repository at this point in the history 
* Added missing OnNotification functions in documentation

* Add 'Client' to autogenerated documentation
  • Loading branch information
@alexvannobel
alexvannobel authored Nov 1, 2019
1 parent 7be2e26 commit 1720532
Show file tree
Hide file tree
Showing 24 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion api_cpp/doc/markdown/summary_pages/ActuatorConfig.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_cpp/doc/markdown/summary_pages/ActuatorCyclic.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_cpp/doc/markdown/summary_pages/Base.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_cpp/doc/markdown/summary_pages/BaseCyclic.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_cpp/doc/markdown/summary_pages/ControlConfig.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_cpp/doc/markdown/summary_pages/DeviceConfig.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_cpp/doc/markdown/summary_pages/DeviceManager.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_cpp/doc/markdown/summary_pages/GripperCyclic.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_cpp/doc/markdown/summary_pages/InterconnectConfig.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_cpp/doc/markdown/summary_pages/InterconnectCyclic.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_cpp/doc/markdown/summary_pages/Session.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_cpp/doc/markdown/summary_pages/VisionConfig.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_python/doc/markdown/summary_pages/ActuatorConfig.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_python/doc/markdown/summary_pages/ActuatorCyclic.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_python/doc/markdown/summary_pages/Base.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_python/doc/markdown/summary_pages/BaseCyclic.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_python/doc/markdown/summary_pages/ControlConfig.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_python/doc/markdown/summary_pages/DeviceConfig.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_python/doc/markdown/summary_pages/DeviceManager.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_python/doc/markdown/summary_pages/GripperCyclic.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_python/doc/markdown/summary_pages/InterconnectConfig.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_python/doc/markdown/summary_pages/InterconnectCyclic.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_python/doc/markdown/summary_pages/Session.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down
2 changes: 1 addition & 1 deletion api_python/doc/markdown/summary_pages/VisionConfig.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
|-------------|-----------|----------|-----------|
Expand Down

0 comments on commit 1720532

Please sign in to comment.