Updated the json and .md file as per the code

MManja792 · Jan 3, 2022 · 2088ee3 · 2088ee3
1 parent 32be3ac
commit 2088ee3
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 19 deletions.
diff --git a/LoggingPreferences/LoggingPreferences.json b/LoggingPreferences/LoggingPreferences.json
@@ -7,11 +7,6 @@
         "description": "The `LoggingPreferences` plugin allows you to control key press logging on a set-top box."
     },
     "definitions": {
-        "keystrokeMaskEnabled_i": {
-            "summary": "Whether keystroke mask is enabled. If `1` (true), then any system that logs keystrokes must mask the actual keystroke being used. Default value is `0` (false).",
-            "type":"integer",
-            "example": 0
-        },
         "keystrokeMaskEnabled_b": {
             "summary": "Whether keystroke mask is enabled (`true`) or disabled (`false`). If `true`, then any system that logs keystrokes must mask the actual keystroke being used. Default value is `false`.",
             "type":"boolean",
@@ -36,12 +31,12 @@
     },
     "methods": {
         "isKeystrokeMaskEnabled": {
-            "summary": "Gets logging keystroke mask status (enabled or disabled)",
+            "summary": "Gets logging keystroke mask status (enabled or disabled). \n \n### Events \n\n No Events.",
             "result": {
                 "type": "object",
                 "properties": {
                     "keystrokeMaskEnabled": {
-                        "$ref": "#/definitions/keystrokeMaskEnabled_i"
+                        "$ref": "#/definitions/keystrokeMaskEnabled_b"
                     },
                     "success": {
                         "$ref": "#/definitions/success"
@@ -54,7 +49,7 @@
             }
         },
         "setKeystrokeMaskEnabled": {
-            "summary": "Sets the keystroke logging mask property. If a keystroke mask is successfully changed, then this method triggers an `onKeystrokeMaskEnabledChange` event.",
+            "summary": "Sets the keystroke logging mask property. If a keystroke mask is successfully changed, then this method triggers an `onKeystrokeMaskEnabledChange` event.\n \n### Events \n| Event | Description | \n| :----------- | :----------- |\n| `onKeystrokeMaskEnabledChange`| Triggered if the keystroke mask is changed successfully |",
             "events": [
                 "onKeystrokeMaskEnabledChange"
             ],

diff --git a/LoggingPreferences/doc/LoggingPreferencesPlugin.md b/LoggingPreferences/doc/LoggingPreferencesPlugin.md
@@ -6,13 +6,14 @@
 
 **Status: :black_circle::black_circle::black_circle:**
 
-org.rdk.LoggingPreferences plugin for Thunder framework.
+A org.rdk.LoggingPreferences plugin for Thunder framework.
 
 ### Table of Contents
 
 - [Introduction](#head.Introduction)
 - [Description](#head.Description)
 - [Configuration](#head.Configuration)
+- [Interfaces](#head.Interfaces)
 - [Methods](#head.Methods)
 - [Notifications](#head.Notifications)
 
@@ -76,6 +77,13 @@ The table below lists configuration options of the plugin.
 | locator | string | Library name: *libWPEFrameworkLoggingPreferences.so* |
 | autostart | boolean | Determines if the plugin shall be started automatically along with the framework |
 
+<a name="head.Interfaces"></a>
+# Interfaces
+
+This plugin implements the following interfaces:
+
+- [LoggingPreferences.json](https://github.com/rdkcentral/ThunderInterfaces/tree/master/interfaces/LoggingPreferences.json)
+
 <a name="head.Methods"></a>
 # Methods
 
@@ -90,9 +98,13 @@ LoggingPreferences interface methods:
 
 
 <a name="method.isKeystrokeMaskEnabled"></a>
-## *isKeystrokeMaskEnabled <sup>method</sup>*
+## *isKeystrokeMaskEnabled [<sup>method</sup>](#head.Methods)*
+
+Gets logging keystroke mask status (enabled or disabled). 
+
+### Events 
 
-Gets logging keystroke mask status (enabled or disabled).
+ No Events.
 
 ### Parameters
 
@@ -103,7 +115,7 @@ This method takes no parameters.
 | Name | Type | Description |
 | :-------- | :-------- | :-------- |
 | result | object |  |
-| result.keystrokeMaskEnabled | integer | Whether keystroke mask is enabled. If `1` (true), then any system that logs keystrokes must mask the actual keystroke being used. Default value is `0` (false) |
+| result.keystrokeMaskEnabled | boolean | Whether keystroke mask is enabled (`true`) or disabled (`false`). If `true`, then any system that logs keystrokes must mask the actual keystroke being used. Default value is `false` |
 | result.success | boolean | Whether the request succeeded |
 
 ### Example
@@ -113,7 +125,7 @@ This method takes no parameters.
 ```json
 {
     "jsonrpc": "2.0",
-    "id": 1234567890,
+    "id": 42,
     "method": "org.rdk.LoggingPreferences.1.isKeystrokeMaskEnabled"
 }
 ```
@@ -123,18 +135,23 @@ This method takes no parameters.
 ```json
 {
     "jsonrpc": "2.0",
-    "id": 1234567890,
+    "id": 42,
     "result": {
-        "keystrokeMaskEnabled": 0,
+        "keystrokeMaskEnabled": false,
         "success": true
     }
 }
 ```
 
 <a name="method.setKeystrokeMaskEnabled"></a>
-## *setKeystrokeMaskEnabled <sup>method</sup>*
+## *setKeystrokeMaskEnabled [<sup>method</sup>](#head.Methods)*
 
 Sets the keystroke logging mask property. If a keystroke mask is successfully changed, then this method triggers an `onKeystrokeMaskEnabledChange` event.
+
+### Events 
+| Event | Description | 
+| :----------- | :----------- |
+| `onKeystrokeMaskEnabledChange`| Triggered if the keystroke mask is changed successfully |.
 
 Also see: [onKeystrokeMaskEnabledChange](#event.onKeystrokeMaskEnabledChange)
 
@@ -159,7 +176,7 @@ Also see: [onKeystrokeMaskEnabledChange](#event.onKeystrokeMaskEnabledChange)
 ```json
 {
     "jsonrpc": "2.0",
-    "id": 1234567890,
+    "id": 42,
     "method": "org.rdk.LoggingPreferences.1.setKeystrokeMaskEnabled",
     "params": {
         "keystrokeMaskEnabled": false
@@ -172,7 +189,7 @@ Also see: [onKeystrokeMaskEnabledChange](#event.onKeystrokeMaskEnabledChange)
 ```json
 {
     "jsonrpc": "2.0",
-    "id": 1234567890,
+    "id": 42,
     "result": {
         "success": true
     }
@@ -194,7 +211,7 @@ LoggingPreferences interface events:
 
 
 <a name="event.onKeystrokeMaskEnabledChange"></a>
-## *onKeystrokeMaskEnabledChange <sup>event</sup>*
+## *onKeystrokeMaskEnabledChange [<sup>event</sup>](#head.Notifications)*
 
 Triggered when the keystroke mask is changed.