Skip to content

not for merge, test #730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sajilal711 wants to merge 8 commits into
base: develop
Choose a base branch
from
Open

not for merge, test #730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
80ffd7d
RDKMEW-12410: Update RDKWindowManager Plugin
sajilal711 Jan 12, 2026
09417f8
address copilot comments
sajilal711 Jan 22, 2026
f8ecdaf
Auto-generate documentation from interface changes
rdkcm-rdke Jan 22, 2026
11f3603
Merge branch 'develop' of github.com:rdkcentral/entservices-apis into…
pkumbh631 Feb 4, 2026
f4f8c66
make setZorder const
sajilal711 Feb 5, 2026
f987937
Disable JSONRPC for IPackageHandler
SKumarMetro Feb 9, 2026
95b8942
Auto-generate documentation from interface changes
rdkcm-rdke Feb 9, 2026
e16ee7a
Merge branch 'develop' into topic/RDKEMW-12410
B-Larsen Feb 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion apis/PackageManager/IAppPackageManager.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,6 @@ namespace Exchange {
};


// @json 1.0.0 @text:keep
struct EXTERNAL IPackageHandler : virtual public Core::IUnknown {
enum { ID = ID_PACKAGE_HANDLER };

Expand Down
28 changes: 28 additions & 0 deletions apis/RDKWindowManager/IRDKWindowManager.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,34 @@ struct EXTERNAL IRDKWindowManager : virtual public Core::IUnknown {
// @retval Core::ERROR_NONE: Successfully retrieved the last key press information.
// @retval Core::ERROR_UNAVAILABLE: No key press information is available.
virtual Core::hresult GetLastKeyInfo(uint32_t &keyCode /* @out */, uint32_t &modifiers /* @out */, uint64_t &timestampInSeconds /* @out */) const = 0;

/** Sets the zOrder of the given client or appInstanceId */
// @text setZOrder
// @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;
Comment on lines +229 to +233
Copy link

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 uses AI. Check for mistakes.

/** Gets the zOrder of the given client or appInstanceId */
// @text getZOrder
// @brief Gets the zOrder of the given client or appInstanceId
// @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;
Comment on lines +238 to +241
Copy link

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 uses AI. Check for mistakes.
Copy link

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 uses AI. Check for mistakes.

/** Starts the VNC server */
// @text startVncServer
// @brief Starts the VNC server
// @retval Core::ERROR_NONE on success
virtual Core::hresult StartVncServer() = 0;
Comment on lines +244 to +247
Copy link

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 uses AI. Check for mistakes.

/** Stops the VNC server */
// @text stopVncServer
// @brief Stops the VNC server
// @retval Core::ERROR_NONE on success
virtual Core::hresult StopVncServer() = 0;
Comment on lines +243 to +253
Copy link

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 generated this review using guidance from repository custom instructions.
Comment on lines +250 to +253
Copy link

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 uses AI. Check for mistakes.
};
} // namespace Exchange
} // namespace WPEFramework
Loading
Loading