RDKEMW-10717 : Update OCIContainer Api header #641
Conversation
ramasat
force-pushed
the
feature/RDKEMW-10717
branch
from
ff71000 to
02dc46c
Compare
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. |
There was a problem hiding this comment.
Pull request overview
This PR updates the OCIContainer API header and documentation by adding brief descriptions for all methods and events. The changes improve the documentation quality by providing concise descriptions of what each API method and event does, making the interface easier to understand and use.
Key Changes
- Added
@brieftags and descriptions to all API methods (15 methods total) in the header file - Updated the OnContainerFailed event description to clarify it only triggers for specific states (start, stop, hibernate, wakeup)
- Synchronized the markdown documentation to reflect the updated descriptions from the header file
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 17 comments.
| File | Description |
|---|---|
| apis/OCIContainer/IOCIContainer.h | Added @brief descriptions for all API methods and updated notification event documentation |
| docs/apis/OCIContainer.md | Updated method and event descriptions in the generated documentation to match header file changes |
Comments suppressed due to low confidence (1)
apis/OCIContainer/IOCIContainer.h:164
- According to the Documentation Tags Guidelines, each method must include
@retvaltags to describe each return code associated with the function. The method is missing@retvaltags.
// @brief Unmount a path in container
// @text unmount
// @param containerId Identifier of container
// @param target path to unmount from container
virtual Core::hresult Unmount(const string& containerId , const string& target , bool& success /* @out */, string& errorReason /* @out */) = 0;
| // @brief Wakeup the container | ||
| // @text wakeupContainer | ||
| // @param containerId Identifier of container | ||
| virtual Core::hresult WakeupContainer(const string& containerId , bool& success /* @out */, string& errorReason /* @out */) = 0; |
There was a problem hiding this comment.
According to the Documentation Tags Guidelines, each method must include @retval tags to describe each return code associated with the function. The method is missing @retval tags.
| // @brief Get the state of container | ||
| // @text getContainerState | ||
| // @param containerId Identifier of container | ||
| virtual Core::hresult GetContainerState(const string& containerId , ContainerState& state /* @out */, bool& success /* @out */, string& errorReason /* @out */) = 0; |
There was a problem hiding this comment.
According to the Documentation Tags Guidelines, each method must include @retval tags to describe each return code associated with the function. The method is missing @retval tags.
| // @brief Start the container from dobby specification | ||
| // @text startContainerFromDobbySpec | ||
| // @param containerId Identifier of container | ||
| // @param dobbySpec dobby specification as json string | ||
| // @param command(optional) command to run in container | ||
| // @param westerosSocket(optional) Westeros socket container need to connect | ||
| virtual Core::hresult StartContainerFromDobbySpec(const string& containerId , const string& dobbySpec , const string& command , const string& westerosSocket , int32_t& descriptor /* @out */, bool& success /* @out */, string& errorReason /* @out */) = 0; |
There was a problem hiding this comment.
According to the Documentation Tags Guidelines, each method must include @retval tags to describe each return code associated with the function. The method is missing @retval tags.
| // @brief Stop the container | ||
| // @text stopContainer | ||
| // @param containerId Identifier of container | ||
| // @param force(optional) Metion forceful or graceful termination of container |
There was a problem hiding this comment.
Spelling error: "Metion" should be "Mention".
| // @param force(optional) Metion forceful or graceful termination of container | |
| // @param force(optional) Mention forceful or graceful termination of container |
| // @brief Stop the container | ||
| // @text stopContainer | ||
| // @param containerId Identifier of container | ||
| // @param force(optional) Metion forceful or graceful termination of container | ||
| virtual Core::hresult StopContainer(const string& containerId , bool force , bool& success /* @out */, string& errorReason /* @out */) = 0; |
There was a problem hiding this comment.
According to the Documentation Tags Guidelines, each method must include @retval tags to describe each return code associated with the function. The method is missing @retval tags.
| // @brief Pause the container | ||
| // @text pauseContainer | ||
| // @param containerId Identifier of container | ||
| virtual Core::hresult PauseContainer(const string& containerId , bool& success /* @out */, string& errorReason /* @out */) = 0; |
There was a problem hiding this comment.
According to the Documentation Tags Guidelines, each method must include @retval tags to describe each return code associated with the function. The method is missing @retval tags.
| // @brief Resume the container | ||
| // @text resumeContainer | ||
| // @param containerId Identifier of container | ||
| virtual Core::hresult ResumeContainer(const string& containerId , bool& success /* @out */, string& errorReason /* @out */) = 0; |
There was a problem hiding this comment.
According to the Documentation Tags Guidelines, each method must include @retval tags to describe each return code associated with the function. The method is missing @retval tags.
| // @brief Provide list of containers | ||
| // @text listContainers | ||
| // @param containers - out/json - string | ||
| virtual Core::hresult ListContainers(string& containers /* @out @opaque */, bool& success /* @out */, string& errorReason /* @out */) = 0; |
There was a problem hiding this comment.
According to the Documentation Tags Guidelines, each method must include @retval tags to describe each return code associated with the function. These descriptions will be included in the generated markdown documentation. The method is missing @retval tags.
| // @brief Execute the command in container | ||
| // @text executeCommand | ||
| // @param containerId Identifier of container | ||
| // @param options(optional) options to be passed to command | ||
| // @param command command to run in container | ||
| virtual Core::hresult ExecuteCommand(const string& containerId , const string& options , const string& command , bool& success /* @out */, string& errorReason /* @out */) = 0; |
There was a problem hiding this comment.
According to the Documentation Tags Guidelines, each method must include @retval tags to describe each return code associated with the function. The method is missing @retval tags.
| // @brief Update container properties | ||
| // @text annotate | ||
| // @param containerId Identifier of container | ||
| // @param key name of property | ||
| // @param value property data | ||
| virtual Core::hresult Annotate(const string& containerId , const string& key , const string& value , bool& success /* @out */, string& errorReason /* @out */) = 0; |
There was a problem hiding this comment.
According to the Documentation Tags Guidelines, each method must include @retval tags to describe each return code associated with the function. The method is missing @retval tags.
Reason for change : Updated API and event information on OCIContainer API header
Risk : Minor
Version : Minor