[Plugins] Remove IMetadata::state enum renaming for JSON-RPC (#1490)

Co-authored-by: Pierre Wielders <[email protected]>
rdkcentral · Jan 9, 2024 · a446bfd · a446bfd
1 parent 3a3884e
commit a446bfd
Showing 1 changed file with 17 additions and 18 deletions.
diff --git a/Source/plugins/IController.h b/Source/plugins/IController.h
@@ -37,7 +37,7 @@ namespace Controller {
     struct EXTERNAL ISystemManagement : virtual public Core::IUnknown {
         enum { ID = RPC::ID_CONTROLLER_SYSTEM_MANAGEMENT };
 
-        // @alt harakiri
+        // @alt:deprecated harakiri
         // @brief Reboots the device
         virtual Core::hresult Reboot() = 0;
 
@@ -78,8 +78,7 @@ namespace Controller {
         virtual Core::hresult DiscoveryResults(Data::IDiscoveryResultsIterator*& results /* @out */) const = 0;
     };
 
-    /* @json */
-    // @json @uncompliant:extended
+    /* @json @uncompliant:extended */
     struct EXTERNAL IConfiguration : virtual public Core::IUnknown {
         enum { ID = RPC::ID_CONTROLLER_CONFIGURATION };
 
@@ -203,16 +202,16 @@ namespace Controller {
 
             struct Service {
                 enum state : uint32_t {
-                    UNAVAILABLE = PluginHost::IShell::UNAVAILABLE /* @text unavailable */,
-                    DEACTIVATED = PluginHost::IShell::DEACTIVATED /* @text deactivated */,
-                    DEACTIVATION = PluginHost::IShell::DEACTIVATION /* @text deactivation */,
-                    ACTIVATED = PluginHost::IShell::ACTIVATED /* @text activated */,
-                    ACTIVATION = PluginHost::IShell::ACTIVATION /* @text activation */,
-                    DESTROYED = PluginHost::IShell::DESTROYED /* @text destroyed */,
-                    PRECONDITION = PluginHost::IShell::PRECONDITION /* @text precondition */,
-                    HIBERNATED = PluginHost::IShell::HIBERNATED /* @text hibernated */,
-                    SUSPENDED /* @text suspended */,
-                    RESUMED /* @text resumed */
+                    UNAVAILABLE = PluginHost::IShell::UNAVAILABLE,
+                    DEACTIVATED = PluginHost::IShell::DEACTIVATED,
+                    DEACTIVATION = PluginHost::IShell::DEACTIVATION,
+                    ACTIVATED = PluginHost::IShell::ACTIVATED,
+                    ACTIVATION = PluginHost::IShell::ACTIVATION,
+                    DESTROYED = PluginHost::IShell::DESTROYED,
+                    PRECONDITION = PluginHost::IShell::PRECONDITION,
+                    HIBERNATED = PluginHost::IShell::HIBERNATED,
+                    SUSPENDED,
+                    RESUMED
                 };
 
                 string Callsign /* @brief Plugin callsign */;
@@ -221,7 +220,7 @@ namespace Controller {
                 string Module /* @brief Module name */;
                 state State /* @brief Current state */;
                 PluginHost::IShell::startmode StartMode /* @brief Startup mode */;
-                bool Resumed /* @brief Determines if the plugin is to be activated in resume or suspend mode */;
+                bool Resumed /* @brief Determines if the plugin is to be activated in resumed or suspended mode */;
                 Data::Version Version /* @brief Version */;
 
                 string Communicator /* @optional */;
@@ -230,12 +229,12 @@ namespace Controller {
                 string VolatilePathPostfix /* @optional */;
                 string SystemRootPath /* @optional */;
 
-                string Precondition /* @opaque @optional @brief Activate conditons */;
-                string Termination /* @opaque @optional @brief Deactivate conditions */;
+                string Precondition /* @opaque @optional @brief Activation conditons */;
+                string Termination /* @opaque @optional @brief Deactivation conditions */;
 
                 string Configuration /* @opaque @optional @brief Plugin configuration */;
 
-                uint16_t Observers /* @optional @brief Number or observers*/;
+                uint16_t Observers /* @optional @brief Number or observers */;
                 uint32_t ProcessedRequests /* @optional @brief Number of API requests that have been processed by the plugin */;
                 uint32_t ProcessedObjects /* @optional @brief Number of objects that have been processed by the plugin */;
             };
@@ -249,7 +248,7 @@ namespace Controller {
             using IServicesIterator = RPC::IIteratorType<Data::Service, RPC::ID_CONTROLLER_METADATA_SERVICES_ITERATOR>;
         };
 
-        // @property @alt status
+        // @property @alt:deprecated status
         // @brief Provides status of a service, including their configurations
         virtual Core::hresult Services(const string& callsign /* @index @optional */, Data::IServicesIterator*& services /* @out @extract */) const = 0;