RDKEMW-10727: Add doxygen tags for RemoteControl and VoiceControl plugins#740
RDKEMW-10727: Add doxygen tags for RemoteControl and VoiceControl plugins#740
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request adds two new interface files for RemoteControl and VoiceControl plugins, intended to provide doxygen documentation tags for JSON-RPC interface definitions. However, the files do not follow the established COM-RPC interface pattern used throughout the codebase.
Changes:
- Added apis/VoiceControl/IVoiceControl.h with class-based plugin implementation
- Added apis/RemoteControl/IRemoteControl.h with struct-based interface but incorrect implementation details
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 22 comments.
| File | Description |
|---|---|
| apis/VoiceControl/IVoiceControl.h | New interface file that incorrectly uses class definition with plugin implementation details instead of proper COM-RPC interface structure |
| apis/RemoteControl/IRemoteControl.h | New interface file that uses correct struct declaration but includes plugin implementation details and doesn't follow established patterns |
docs/apis/VoiceControl.md
Outdated
| | params | object | | | ||
| | params.parameters | JsonObject | Input parameters (unused) | | ||
| | params.response | JsonObject | JSON response object @retval 0: Success | | ||
| ### Results | ||
| | Name | Type | Description | | ||
| | :-------- | :-------- | :-------- | | ||
| | result | null | On success null will be returned. | |
There was a problem hiding this comment.
This generated doc now describes each method as taking generic parameters/response JsonObject fields and returning null, which drops the detailed request/response schema that previously existed in docs/apis/VoiceControlPlugin.md (removed in this PR). If the API surface hasn’t actually changed, consider updating the stubgen interface/types so the generated markdown retains the real method params/results (or keep the previous detailed doc).
| | params | object | | | |
| | params.parameters | JsonObject | Input parameters (unused) | | |
| | params.response | JsonObject | JSON response object @retval 0: Success | | |
| ### Results | |
| | Name | Type | Description | | |
| | :-------- | :-------- | :-------- | | |
| | result | null | On success null will be returned. | | |
| | params | object | Method call parameters | | |
| | params.parameters | JsonObject | Input parameters | | |
| ### Results | |
| | Name | Type | Description | | |
| | :-------- | :-------- | :-------- | | |
| | result | object | Method call result | | |
| | result.response | JsonObject | JSON response object @retval 0: Success | |
| ### Parameters | ||
| | Name | Type | Description | | ||
| | :-------- | :-------- | :-------- | | ||
| | params | object | | | ||
| | params.parameters | JsonObject | Input parameters (unused) | | ||
| | params.response | JsonObject | JSON response object @retval 0: Success | | ||
| ### Results | ||
| | Name | Type | Description | | ||
| | :-------- | :-------- | :-------- | | ||
| | result | null | On success null will be returned. | | ||
|
|
There was a problem hiding this comment.
This generated doc now describes each method as taking generic parameters/response JsonObject fields and returning null, which drops the detailed request/response schema that previously existed in docs/apis/RemoteControlPlugin.md (removed in this PR). If the API surface hasn’t actually changed, update the stubgen interface/types so the generated markdown retains the real method params/results (or keep the previous detailed doc).
Documentation Auto-GeneratedDocumentation has been automatically generated for the changed plugins and committed to this PR branch. The generated documentation files have been added to the PR for review. |
…ntservices-apis into feature/RDKEMW-10727
Documentation Auto-GeneratedDocumentation has been automatically generated for the changed plugins and committed to this PR branch. The generated documentation files have been added to the PR for review. |
…ntservices-apis into feature/RDKEMW-10727
Documentation Auto-GeneratedDocumentation has been automatically generated for the changed plugins and committed to this PR branch. The generated documentation files have been added to the PR for review. |
…ntservices-apis into feature/RDKEMW-10727
Documentation Auto-GeneratedDocumentation has been automatically generated for the changed plugins and committed to this PR branch. The generated documentation files have been added to the PR for review. |
…ntservices-apis into feature/RDKEMW-10727
Documentation Auto-GeneratedDocumentation has been automatically generated for the changed plugins and committed to this PR branch. The generated documentation files have been added to the PR for review. |
Documentation Auto-GeneratedDocumentation has been automatically generated for the changed plugins and committed to this PR branch. The generated documentation files have been added to the PR for review. |
Documentation Auto-GeneratedDocumentation has been automatically generated for the changed plugins and committed to this PR branch. The generated documentation files have been added to the PR for review. |
https://ccp.sys.comcast.net/browse/RDKEMW-10727