Merge pull request #5962 from hgfell683/main

DELIA-66702: Documentation update
rdkcentral · Dec 24, 2024 · 7ad8fde · 7ad8fde
2 parents 47741c1 + 4265020
commit 7ad8fde
Show file tree

Hide file tree

Showing 6 changed files with 70 additions and 44 deletions.
diff --git a/DisplaySettings/CHANGELOG.md b/DisplaySettings/CHANGELOG.md
@@ -16,6 +16,10 @@ All notable changes to this RDK Service will be documented in this file.
 
 * For more details, refer to [versioning](https://github.com/rdkcentral/rdkservices#versioning) section under Main README.
 
+## [2.0.2] - 2024-12-03
+### Fixed
+- Corrected the documentation for several functions to make them more accurate for their actual use.
+
 ## [2.0.1] - 2024-12-03
 ### Fixed
 - Fixed unhandled exception that was occasionally causing a crash if thread creation failed.

diff --git a/DisplaySettings/DisplaySettings.cpp b/DisplaySettings/DisplaySettings.cpp
@@ -85,7 +85,7 @@ using namespace std;
 
 #define API_VERSION_NUMBER_MAJOR 2
 #define API_VERSION_NUMBER_MINOR 0
-#define API_VERSION_NUMBER_PATCH 0
+#define API_VERSION_NUMBER_PATCH 2
 
 static bool isCecEnabled = false;
 static bool isResCacheUpdated = false;

diff --git a/DisplaySettings/DisplaySettings.json b/DisplaySettings/DisplaySettings.json
@@ -28,7 +28,7 @@
             "type": "array",
             "items": {
                 "type": "string",
-                "example": "`SDR`, `HDR10`, `HDR10PLUS`, `HLG`, `DV`, `Technicolor Prime`"
+                "example": "`NONE`, `SDR`, `HDR10`, `HDR10PLUS`, `HLG`, `DV`, `Technicolor Prime`"
             }
         },
         "currentAudioFormat": {
@@ -2073,17 +2073,17 @@
             }
         },
         "setForceHDRMode": {
-            "summary": "Enables or disables the force HDR mode. If enabled, the HDR format that is currently configured on the device is used.",
+            "summary": " This API force the output HDR video format passed as input arumgents. If force output video format is set as \"NONE\"  or this API not called video format changes as per input video format type",
             "params": {
                 "type": "object",
                 "properties": {
                     "hdr_mode": {
-                        "summary": "`true` to force the HDR format or `false` to reset the mode to the default.",
-                        "type": "boolean",
-                        "example": true
+                        "$ref": "#/definitions/supportedVideoFormat"
                     }
                 },
-                "required": []
+                "required": [
+                   "hdr_mode"
+                ]
             },
             "result": {
                 "$ref": "#/common/result"
@@ -2224,22 +2224,22 @@
                     "operation": {
                         "summary": "The audio profile state",
                         "type": "string",
-                        "example": ""
+                        "example": "`ADD`, `REMOVE`"
                     },
                     "profileName": {
                         "summary": "An MS12 audio profile name from `getSupportedMS12AudioProfile`",
                          "type": "string",
-                        "example": "Sports"
+                        "example": "`Sports`, `User`"
                     },
                     "ms12SettingsName": {
                         "summary": "An ms12 setting name",
                         "type": "string",
-                        "example": "Dialog Enhance"
+                        "example": "`DialogEnhance`, `VolumeLevellerMode`, `VolumeLevellerLevel`, `BassEnhancer`, `SurroundVirtualizerMode`, `SurroundVirtualizerLevel`"
                     },
                     "ms12SettingsValue": {
                         "summary": "The value to set",
                         "type": "string",
-                        "example": "On"
+                        "example": "`0`, `1`, `2`"
                     }
                 },
                 "required": [

diff --git a/SystemServices/CHANGELOG.md b/SystemServices/CHANGELOG.md
@@ -16,6 +16,10 @@ All notable changes to this RDK Service will be documented in this file.
 
 * For more details, refer to [versioning](https://github.com/rdkcentral/rdkservices#versioning) section under Main README.
 
+## [3.4.1] - 2024-12-03
+### Fixed
+- Fixed the location of the get and set FSR functions within the documentation.
+
 ## [3.4.0] - 2024-12-09
 ### Added
 - Added implementation for BootType get API.

diff --git a/SystemServices/System.json b/SystemServices/System.json
@@ -1945,6 +1945,46 @@
                 ]
             }
         },
+        "setFSRFlag":{
+            "summary": "Set the FSR flag into the emmc raw area. This API will fail if you attempt to set the same value.",
+            "result": {
+                "type": "object",
+                "properties": {
+                    "fsrFlag": {
+                        "summary": "FSR flag",
+                        "type": "boolean",
+                        "example": true
+                    },
+                    "success":{
+                        "$ref": "#/common/success"
+                    }
+                },
+                "required": [
+                    "fsrFlag",
+                    "success"
+                ]
+            }
+        },
+        "getFSRFlag":{
+            "summary": "Get the FSR flag from the emmc raw area.",
+            "result": {
+                "type": "object",
+                "properties": {
+                    "fsrFlag": {
+                        "summary": "FSR flag.",
+                        "type": "boolean",
+                        "example": true
+                    },
+                    "success":{
+                        "$ref": "#/common/success"
+                    }
+                },
+                "required": [
+                    "fsrFlag",
+                    "success"
+                ]
+            }
+        },
         "setPrivacyMode": {
             "summary": "Setting Privacy Mode.",          
             "events": {
@@ -2394,43 +2434,21 @@
                 ]
             }
         },
-        "setFSRFlag":{
-            "summary": "Set the FSR flag into the emmc raw area. This API will fail if you attempt to set the same value.",
-            "result": {
-                "type": "object",
-                "properties": {
-                    "fsrFlag": {
-                        "summary": "FSR flag",
-                        "type": "boolean",
-                        "example": true
-                    },
-                    "success":{
-                        "$ref": "#/common/success"
-                    }
-                },
-                "required": [
-                    "fsrFlag",
-                    "success"
-                ]
-            }
-        },
-        "getFSRFlag":{
-            "summary": "Get the FSR flag from the emmc raw area.",
-            "result": {
-                "type": "object",
+        "onBlocklistChanged":{
+            "summary": "Triggers when the blocklist flag is modified",
+            "params": {
+                "type" :"object",
                 "properties": {
-                    "fsrFlag": {
-                        "summary": "FSR flag.",
-                        "type": "boolean",
-                        "example": true
+                    "oldBlocklistFlag": {
+                        "$ref": "#/definitions/oldblocklist"
                     },
-                    "success":{
-                        "$ref": "#/common/success"
+                    "newBlocklistFlag": {
+                        "$ref": "#/definitions/newblocklist"
                     }
                 },
                 "required": [
-                    "fsrFlag",
-                    "success"
+                    "oldBlocklistFlag",
+                    "newBlocklistFlag"
                 ]
             }
         }

diff --git a/SystemServices/SystemServices.cpp b/SystemServices/SystemServices.cpp
@@ -67,7 +67,7 @@ using namespace std;
 
 #define API_VERSION_NUMBER_MAJOR 3
 #define API_VERSION_NUMBER_MINOR 4
-#define API_VERSION_NUMBER_PATCH 0
+#define API_VERSION_NUMBER_PATCH 1
 
 #define MAX_REBOOT_DELAY 86400 /* 24Hr = 86400 sec */
 #define TR181_FW_DELAY_REBOOT "Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.AutoReboot.fwDelayReboot"