not for merge, test by sajilal711 · Pull Request #730 · rdkcentral/entservices-apis

sajilal711 · 2026-02-12T05:09:14Z

No description provided.

-SetZOrder, GetZOrder, StartVncServer, StopVncServer Signed-off-by: sajilal711 <shreyas.sajilal@gmail.com>

… topic/RDKEMW-12410

Copilot

Pull request overview

This PR updates the RDKWindowManager API surface (and its generated markdown) to document and expose z-order control plus VNC server start/stop, and adjusts PackageManager generated documentation/annotations.

Changes:

Add SetZOrder/GetZOrder and VNC server control methods to IRDKWindowManager.
Update docs/apis/RDKWindowManager.md to include the new methods and re-number example request IDs.
Adjust PackageManager docs ordering and remove the JSON-RPC tagging line for IPackageHandler.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 11 comments.

File	Description
docs/apis/RDKWindowManager.md	Adds documentation entries for z-order and VNC server APIs and shifts example IDs.
docs/apis/PackageManager.md	Reorders method list/sections and removes `getLockedInfo` documentation section.
apis/RDKWindowManager/IRDKWindowManager.h	Adds new z-order + VNC server API methods.
apis/PackageManager/IAppPackageManager.h	Removes the `@json ... @text:keep` marker above `IPackageHandler`.

Copilot · 2026-02-12T05:15:57Z

docs/apis/RDKWindowManager.md

+| [startVncServer](#startVncServer) | Starts the VNC server @retval Core::ERROR_NONE on success |
+| [stopVncServer](#stopVncServer) | Stops the VNC server @retval Core::ERROR_NONE on success |


The methods table includes @retval ... text in the short descriptions for startVncServer/stopVncServer, which reads like a Doxygen tag leaking into the generated markdown. Keep the table description user-focused (what it does) and put return-code details in the appropriate results/error section instead.

Suggested change

| [startVncServer](#startVncServer) | Starts the VNC server @retval Core::ERROR_NONE on success |

| [stopVncServer](#stopVncServer) | Stops the VNC server @retval Core::ERROR_NONE on success |

| [startVncServer](#startVncServer) | Starts the VNC server |

| [stopVncServer](#stopVncServer) | Stops the VNC server |

Copilot · 2026-02-12T05:15:58Z

docs/apis/RDKWindowManager.md

+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| result | object |  |
+| result.zOrder | integer | integer value indicating the zOrder @retval Core::ERROR_NONE on success |


In this markdown, the @retval Core::ERROR_NONE on success fragment appears inside the field description (result.zOrder). That looks like a documentation tag leaking into the generated output; it should be expressed as a return code description rather than part of a data field description.

Suggested change

| result.zOrder | integer | integer value indicating the zOrder @retval Core::ERROR_NONE on success |

| result.zOrder | integer | integer value indicating the zOrder |

Copilot · 2026-02-12T05:15:58Z

docs/apis/RDKWindowManager.md

+| :-------- | :-------- | :-------- |
+| params | object |  |
+| params.appInstanceId | string | the identifier of the connected application |
+| params.zOrder | integer | integer value indicating the zOrder @retval Core::ERROR_NONE on success |


The parameter description for params.zOrder includes @retval Core::ERROR_NONE on success, which is a return-code detail and doesn't belong in a parameter description. Move/express return codes separately so the parameter docs stay purely about inputs.

Suggested change

| params.zOrder | integer | integer value indicating the zOrder @retval Core::ERROR_NONE on success |

| params.zOrder | integer | integer value indicating the zOrder |

Copilot · 2026-02-12T05:15:58Z

apis/RDKWindowManager/IRDKWindowManager.h

+  // @param appInstanceId: client name or application instance ID
+  // @param zOrder: integer value indicating the zOrder of the client
+  // @retval Core::ERROR_NONE on success
+  virtual Core::hresult GetZOrder(const string& appInstanceId, int32_t &zOrder /* @out */) = 0;


The @retval line for GetZOrder is missing the required : <Description> portion (e.g., @retval Core::ERROR_NONE: Successfully retrieved z-order).

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#documentation-tags-guidelines

Copilot · 2026-02-12T05:15:58Z

docs/apis/RDKWindowManager.md

+<a id="startVncServer"></a>
+## *startVncServer*
+
+Starts the VNC server @retval Core::ERROR_NONE on success


The short description line includes an @retval ... fragment (Starts the VNC server @retval ...), which looks like a Doxygen tag leaking into the generated markdown. Keep the description as plain text and document return codes separately.

Suggested change

Starts the VNC server @retval Core::ERROR_NONE on success

Starts the VNC server.

Copilot · 2026-02-12T05:15:59Z

apis/RDKWindowManager/IRDKWindowManager.h

+  /** Starts the VNC server */
+  // @text startVncServer
+  // @brief Starts the VNC server
+  // @retval Core::ERROR_NONE on success
+  virtual Core::hresult StartVncServer() = 0;
+
+  /** Stops the VNC server */
+  // @text stopVncServer
+  // @brief Stops the VNC server
+  // @retval Core::ERROR_NONE on success
+  virtual Core::hresult StopVncServer() = 0;


StartVncServer/StopVncServer use mixed-case for the acronym ("Vnc"). Per the repo guideline, acronyms should be fully capitalized; consider renaming to StartVNCServer/StopVNCServer (and updating the corresponding @text JSON-RPC names/docs accordingly) while the API is still new.

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#acronym-capitalization

Copilot · 2026-02-12T05:15:59Z

apis/RDKWindowManager/IRDKWindowManager.h

+  // @brief Sets the zOrder of the given client or appInstanceId
+  // @param appInstanceId: client name or application instance ID
+  // @param zOrder: integer value indicating the zOrder
+  // @retval Core::ERROR_NONE on success
+  virtual Core::hresult SetZOrder(const string& appInstanceId, const int32_t zOrder) = 0;


The new @retval tag format is inconsistent with the documented requirement (@retval <ErrorCode>: <Description>). Here it is missing the colon + description (e.g., Core::ERROR_NONE: ...), which can also leak into generated markdown.

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#documentation-tags-guidelines

Copilot · 2026-02-12T05:15:59Z

apis/RDKWindowManager/IRDKWindowManager.h

+  // @param appInstanceId: client name or application instance ID
+  // @param zOrder: integer value indicating the zOrder of the client
+  // @retval Core::ERROR_NONE on success
+  virtual Core::hresult GetZOrder(const string& appInstanceId, int32_t &zOrder /* @out */) = 0;


GetZOrder is a getter but is not marked const, unlike other getters in this interface (e.g., GetApps, GetKeyRepeatsEnabled, GetLastKeyInfo). If it doesn't mutate state, make it const for API consistency and usability on const instances.

Suggested change

virtual Core::hresult GetZOrder(const string& appInstanceId, int32_t &zOrder /* @out */) = 0;

virtual Core::hresult GetZOrder(const string& appInstanceId, int32_t &zOrder /* @out */) const = 0;

Copilot · 2026-02-12T05:15:59Z

apis/RDKWindowManager/IRDKWindowManager.h

+  // @text startVncServer
+  // @brief Starts the VNC server
+  // @retval Core::ERROR_NONE on success
+  virtual Core::hresult StartVncServer() = 0;


The new @retval tag format is missing the required : <Description> portion (e.g., @retval Core::ERROR_NONE: <...>).

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#documentation-tags-guidelines

Copilot · 2026-02-12T05:15:59Z

apis/RDKWindowManager/IRDKWindowManager.h

+  // @text stopVncServer
+  // @brief Stops the VNC server
+  // @retval Core::ERROR_NONE on success
+  virtual Core::hresult StopVncServer() = 0;


The new @retval tag format is missing the required : <Description> portion (e.g., @retval Core::ERROR_NONE: <...>).

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#documentation-tags-guidelines

sajilal711 and others added 8 commits January 21, 2026 12:38

RDKMEW-12410: Update RDKWindowManager Plugin

80ffd7d

-SetZOrder, GetZOrder, StartVncServer, StopVncServer Signed-off-by: sajilal711 <shreyas.sajilal@gmail.com>

address copilot comments

09417f8

Auto-generate documentation from interface changes

f8ecdaf

Merge branch 'develop' of github.com:rdkcentral/entservices-apis into…

11f3603

… topic/RDKEMW-12410

make setZorder const

f4f8c66

Disable JSONRPC for IPackageHandler

f987937

Auto-generate documentation from interface changes

95b8942

Merge branch 'develop' into topic/RDKEMW-12410

e16ee7a

Copilot AI review requested due to automatic review settings February 12, 2026 05:09

sajilal711 requested a review from a team as a code owner February 12, 2026 05:09

Copilot started reviewing on behalf of sajilal711 February 12, 2026 05:09 View session

Copilot AI reviewed Feb 12, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

not for merge, test#730

not for merge, test#730
sajilal711 wants to merge 8 commits intodevelopfrom
topic/12410test

sajilal711 commented Feb 12, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

		\| [startVncServer](#startVncServer) \| Starts the VNC server @retval Core::ERROR_NONE on success \|
		\| [stopVncServer](#stopVncServer) \| Stops the VNC server @retval Core::ERROR_NONE on success \|

	\| result.zOrder \| integer \| integer value indicating the zOrder @retval Core::ERROR_NONE on success \|
	\| result.zOrder \| integer \| integer value indicating the zOrder \|

	\| params.zOrder \| integer \| integer value indicating the zOrder @retval Core::ERROR_NONE on success \|
	\| params.zOrder \| integer \| integer value indicating the zOrder \|

	Starts the VNC server @retval Core::ERROR_NONE on success
	Starts the VNC server.

	virtual Core::hresult GetZOrder(const string& appInstanceId, int32_t &zOrder /* @out */) = 0;
	virtual Core::hresult GetZOrder(const string& appInstanceId, int32_t &zOrder /* @out */) const = 0;

Conversation

sajilal711 commented Feb 12, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants