TEST-123: Test PR for custom coding guidelines #625

ssitar583 · 2025-11-12T18:17:00Z

No description provided.

Copilot

Pull Request Overview

This pull request introduces multiple violations of the Thunder Plugins Interface Guidelines across two interface header files. The changes appear to be testing various coding guideline violations rather than implementing legitimate functionality.

Key changes:

Modified enum naming conventions and notification method implementations in XCast interface
Changed JSON-RPC tagging, method return types, and event naming in HdcpProfile interface
Removed and modified documentation comments and parameter annotations

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 13 comments.

File	Description
apis/XCast/IXCast.h	Contains violations in enum naming (lowercase, special characters), notification interface implementation (pure virtual instead of default), parameter naming (@text annotations not in camelCase), improper @in tag usage, missing @out tags, and incorrect setter @text annotation
apis/HdcpProfile/IHdcpProfile.h	Contains violations in JSON-RPC tagging (missing @text:keep), event naming (@text annotation too generic), method name casing (ONDisplayConnectionChanged), incorrect return type (uint32_t instead of Core::hresult), and @text annotation not in camelCase

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-12T18:19:06Z

apis/XCast/IXCast.h

 				// @param applicationName: Registered application name
 				// @param applicationId: Application instance ID
-				virtual void OnApplicationResumeRequest(const string& appName /* @text applicationName */ , const string& appID /* @text applicationId */)  {};
+				virtual void OnApplicationResumeRequest(const string& appName /* @text applicationName */ , const string& AppID /* @text applicationId */)  {};


All parameter names in JSON RPC requests/responses SHOULD use camelCase. The @text annotation AppID should be applicationId (first letter must be lowercase, and consistent with the parameter naming convention in the documentation).

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#parameter-naming--tagging

Copilot · 2025-11-12T18:19:07Z

apis/HdcpProfile/IHdcpProfile.h

                enum { ID = ID_HDCPPROFILE_NOTIFICATION };

-                // @text onDisplayConnectionChanged
+                // @text onChanged


Event names SHOULD follow the on[Object][Action] convention and use camelCase for JSON-RPC via @text annotation. The @text annotation onChanged does not follow the naming convention and lacks context. It should be onDisplayConnectionChanged to match the method name pattern.

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#event-naming-convention

Copilot · 2025-11-12T18:19:07Z

apis/HdcpProfile/IHdcpProfile.h

            // @param HDCPStatus: Contains HDCP-related data as separate properties
            // @param success: Indicates whether the operation was successful
-            virtual Core::hresult GetHDCPStatus(HDCPStatus& hdcpStatus /* @out @text HDCPStatus*/,bool& success  /* @out */) = 0;
+            virtual uint32_t GetHDCPStatus(HDCPStatus& hdcpStatus /* @out @text HDCPStatus*/,bool& success  /* @out */) = 0;


All methods MUST return Core::hresult. The return type has been changed from Core::hresult to uint32_t, which violates the interface guidelines. This should be reverted to Core::hresult.

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#method-return-type

Copilot · 2025-11-12T18:19:07Z

apis/HdcpProfile/IHdcpProfile.h


            /**********************getSettopHDCPSupport() - start*********************************/
-            // @text getSettopHDCPSupport
+            // @text GetSettopHDCPSupport


API names SHOULD be defined in camelCase for JSON-RPC definition via @text annotation. The @text annotation GetSettopHDCPSupport should be getSettopHDCPSupport (first letter must be lowercase).

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#api--event-naming-for-interface-and-json-rpc

Copilot · 2025-11-12T18:19:08Z

apis/XCast/IXCast.h

 			enum StandbyBehavior : uint8_t {
 				ACTIVE = 0 /* @text active */,
-				INACTIVE = 1 /* @text inactive */
+				inactive = 1 /* @text inactive */


Enum names SHOULD be in ALL_UPPER_SNAKE_CASE. The enum value inactive should be INACTIVE to maintain consistency with naming conventions.

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

Copilot · 2025-11-12T18:19:09Z

apis/XCast/IXCast.h

 			// @param manufacturer: The Manufacturer name of the device which used to update in dd.xml
 			// @param success: Whether the request succeeded
-			virtual Core::hresult GetManufacturerName(string &manufacturername /* @out @text manufacturer */, bool &success /* @out */) = 0;
+			virtual Core::hresult GetManufacturerName(string &manufacturername /* @out @text manufacturer */, bool &success) = 0;


Use @out tag for output parameters. The success parameter is missing the /* @out */ tag since it's an output parameter passed by reference.

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#parameter-naming--tagging

Copilot · 2025-11-12T18:19:09Z

apis/XCast/IXCast.h


 			/****************************************setEnabled()**********************************/
-			// @text setEnabled
+			// @text Enabled


API names SHOULD be defined in camelCase for JSON-RPC definition via @text annotation. The @text annotation Enabled should be setEnabled (first letter lowercase, and method name should match the setter convention).

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#api--event-naming-for-interface-and-json-rpc

@copilot open a new pull request to apply changes based on this feedback

Copilot · 2025-11-12T18:19:09Z

apis/HdcpProfile/IHdcpProfile.h

     namespace Exchange
     {
-         /* @json 1.0.0 @text:keep */
+         /* @json 1.0.0*/


If an interface implements JSON-RPC and includes the @JSON tag with a version, the interface must also include the @text:keep tag. The @text:keep tag is missing from this line.

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#json-rpc-tagging

@copilot open a new pull request to apply changes based on this feedback

Copilot · 2025-11-12T18:19:09Z

apis/HdcpProfile/IHdcpProfile.h

                // @brief Triggered if HDMI was connected or disconnected upon receiving onHdmiOutputHotPlug
                // @param HDCPStatus: Contains HDCP-related data as separate properties
-                virtual void OnDisplayConnectionChanged(const HDCPStatus hdcpStatus/* @text HDCPStatus*/) {};
+                virtual void ONDisplayConnectionChanged(const HDCPStatus hdcpStatus/* @text HDCPStatus*/) {};


Method names SHOULD be in PascalCase in the interface header. The method name ONDisplayConnectionChanged has incorrect casing - it should be OnDisplayConnectionChanged (with lowercase 'n' after 'O').

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#api--event-naming-for-interface-and-json-rpc

Copilot · 2025-11-12T18:19:10Z

apis/XCast/IXCast.h

 				// @param applicationName: Registered application name
 				// @param parameter: Application launch string
-				virtual void OnApplicationLaunchRequest(const string& appName /* @text applicationName */ , const string& parameter /* @text parameter */ )  {};
+				virtual void OnApplicationLaunchRequest(const string& appName /* @text applicationName */ , const string& parameter /* @text parameter */ ) = 0;


Notification interfaces MUST provide default (empty) implementations for notification methods. Do NOT use pure virtual methods (= 0). This method should have {} instead of = 0.

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

Copilot · 2025-11-12T18:50:23Z

@ssitar583 I've opened a new pull request, #626, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2025-11-12T18:54:19Z

@ssitar583 I've opened a new pull request, #627, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-13T07:12:11Z

apis/HdcpProfile/IHdcpProfile.h

            // @param HDCPStatus: Contains HDCP-related data as separate properties
            // @param success: Indicates whether the operation was successful
-            virtual Core::hresult GetHDCPStatus(HDCPStatus& hdcpStatus /* @out @text HDCPStatus*/,bool& success  /* @out */) = 0;
+            virtual uint32_t GetHDCPStatus(HDCPStatus& hdcpStatus /* @out @text HDCPStatus*/,bool& success  /* @out */) = 0;


All methods MUST return Core::hresult. The return type uint32_t should be changed to Core::hresult.

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#method-return-type

Copilot

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-13T07:27:37Z

apis/XCast/IXCast.h

 			// @param manufacturer: The Manufacturer name of the device which used to update in dd.xml
 			// @param success: Whether the request succeeded
-			virtual Core::hresult GetManufacturerName(string &manufacturername /* @out @text manufacturer */, bool &success /* @out */) = 0;
+			virtual Core::hresult GetManufacturerName(string &manufacturername /* @out @text manufacturer */, bool &success) = 0;


Missing @out tag for the output parameter "success". Output parameters MUST be tagged with @out.

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

Copilot · 2025-11-13T07:27:37Z

apis/XCast/IXCast.h


 			/****************************************setEnabled()**********************************/
-			// @text setEnabled
+			// @text Enabled


The @text annotation "Enabled" violates camelCase naming convention for JSON RPC. This should be "setEnabled" to match the setter naming pattern.

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

Copilot · 2025-11-13T07:27:37Z

apis/XCast/IXCast.h

 				// @param applicationName: Registered application name
 				// @param applicationId: Application instance ID
-				virtual void OnApplicationResumeRequest(const string& appName /* @text applicationName */ , const string& appID /* @text applicationId */)  {};
+				virtual void OnApplicationResumeRequest(const string& appName /* @text applicationName */ , const string& AppID /* @text applicationId */)  {};


Parameter @text tag "AppID" violates camelCase naming convention. The first letter must be lowercase. This should be "applicationId".

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

Copilot

Pull Request Overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

ssitar583 added 2 commits November 12, 2025 23:43

Update IHdcpProfile.h

d9c373f

TEST-123: Update IXCast.h

12f297b

ssitar583 requested a review from a team as a code owner November 12, 2025 18:17

Copilot AI review requested due to automatic review settings November 12, 2025 18:17

Copilot started reviewing on behalf of ssitar583 November 12, 2025 18:17 View session

Copilot finished reviewing on behalf of ssitar583 November 12, 2025 18:18

Copilot AI reviewed Nov 12, 2025

View reviewed changes

Copilot AI mentioned this pull request Nov 12, 2025

Add @text:keep tag to IHdcpProfile interface #626

Draft

Copilot AI mentioned this pull request Nov 12, 2025

Fix SetEnabled @text annotation to follow camelCase convention #627

Draft

ssitar583 requested a review from Copilot November 13, 2025 07:10

Copilot started reviewing on behalf of ssitar583 November 13, 2025 07:10 View session

Copilot finished reviewing on behalf of ssitar583 November 13, 2025 07:11

Copilot AI reviewed Nov 13, 2025

View reviewed changes

Update IXCast.h

575d1d2

ssitar583 requested a review from Copilot November 13, 2025 07:25

Copilot started reviewing on behalf of ssitar583 November 13, 2025 07:25 View session

Copilot finished reviewing on behalf of ssitar583 November 13, 2025 07:27

Copilot AI reviewed Nov 13, 2025

View reviewed changes

Update IMiracastService.h

f5512af

ssitar583 requested a review from Copilot November 13, 2025 09:24

Copilot started reviewing on behalf of ssitar583 November 13, 2025 09:24 View session

Copilot finished reviewing on behalf of ssitar583 November 13, 2025 09:26

Copilot AI reviewed Nov 13, 2025

View reviewed changes

TEST-123: Test PR for custom coding guidelines #625

Are you sure you want to change the base?

TEST-123: Test PR for custom coding guidelines #625

Uh oh!

Conversation

ssitar583 commented Nov 12, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

ssitar583 Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

ssitar583 Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Nov 12, 2025

Uh oh!

Copilot AI commented Nov 12, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Reviewers

Assignees

Labels

Projects