Json meta to IDL changes in progress

rdkcentral · Nov 8, 2024 · 7a79de7 · 7a79de7
1 parent ce2bbee
commit 7a79de7
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 27 deletions.
diff --git a/interfaces/IBrowser.h b/interfaces/IBrowser.h
@@ -126,10 +126,10 @@ namespace Exchange {
         // @param fps: Current FPS
         virtual uint32_t FPS(uint8_t& fps /* @out */) const = 0;
 
-        /* @json:omit @alt:deprecated */
-        virtual uint32_t HeaderList(string& headerlist /* @out */) const = 0;
-        /* @json:omit @alt:deprecated */
-        virtual uint32_t HeaderList(const string& headerlist ) = 0;
+        /* @json:omit */
+        DEPRECATED virtual uint32_t HeaderList(string& headerlist /* @out */) const = 0;
+        /* @json:omit */
+        DEPRECATED virtual uint32_t HeaderList(const string& headerlist ) = 0;
 
         // @property
         // @brief UserAgent string used by the browser
@@ -162,11 +162,11 @@ namespace Exchange {
         // @brief Initiate garbage collection
         virtual uint32_t CollectGarbage() = 0;
         // @property
-        // @brief Languages: Browser prefered languages
+        // @brief Browser prefered languages
         virtual uint32_t Languages(IStringIterator*& languages /* @out */) const = 0;
         virtual uint32_t Languages(IStringIterator* const languages) = 0;
         // @property
-        // @brief Headers: Headers to send on all requests that the browser makes
+        // @brief Headers to send on all requests that the browser makes
         virtual uint32_t Headers(IHeadersIterator*& headers /* @out */) const = 0;
         virtual uint32_t Headers(IHeadersIterator* const headers) = 0;
     };

diff --git a/interfaces/IDeviceInfo.h b/interfaces/IDeviceInfo.h
@@ -102,8 +102,8 @@ namespace Exchange {
         struct AudioOutputCaps {
             IDeviceAudioCapabilities::AudioOutput audioOutput /* @brief Audio Output support */;
             IDeviceAudioCapabilities::AudioCapability audioCapabilities /* @bitmask @brief Retrieves AudioCapabilities */;
-            IDeviceAudioCapabilities::MS12Capability ms12Capabilities /* @bitmask @brief Retrieves MS12 Capabilities */;
-            IDeviceAudioCapabilities::MS12Profile ms12Profiles /* @bitmask @brief Retrieves MS12 Audio Profiles */;
+            IDeviceAudioCapabilities::MS12Capability ms12Capabilities /* @optional @bitmask @brief Retrieves MS12 Capabilities */;
+            IDeviceAudioCapabilities::MS12Profile ms12Profiles /* @optional @bitmask @brief Retrieves MS12 Audio Profiles */;
         };
 
         using IAudioOutputCapsIterator = RPC::IIteratorType<AudioOutputCaps, ID_DEVICE_CAPABILITIES_AUDIO_OUTPUT>;
@@ -226,9 +226,9 @@ namespace Exchange {
         virtual ~IDeviceMetadata() override = default;
 
         struct Device {
-            string deviceType /* @brief Device type */;
-            string distributorId /* @brief Partner ID or distributor ID for device */;
-            string friendlyName /* @brief Friendly name */;
+            string deviceType;
+            string distributorId /* @optional @brief Partner ID or distributor ID for device */;
+            string friendlyName /* @optional @brief Friendly name */;
             string make /* @brief Device manufacturer */;
             string modelName /* @brief Model Name */;
             uint16_t modelYear /* @brief Model Year */;
@@ -249,17 +249,10 @@ namespace Exchange {
         virtual ~IImageMetadata() override = default;
 
         struct Firmware {
-            enum Yocto : uint8_t {
-                dunfell,
-                morty,
-                daisy,
-                kirkstone
-            };
-
             string imageName /* @brief Name of firmware image */;
-            string sdk /* @brief SDK version string */;
-            string mediarite /* @brief Mediarite value */;
-            Yocto yocto /* @brief Yocto version */;
+            string sdk /* @optional @brief SDK version string */;
+            string mediarite /* @optional @brief Mediarite value */;
+            string yocto /* @brief Yocto version */;
         };
 
         // @property

diff --git a/interfaces/IMonitor.h b/interfaces/IMonitor.h
@@ -69,20 +69,23 @@ namespace Exchange {
         virtual Core::hresult Unregister(INotification* notification) = 0;
 
         // @property
-        // @brief RestartLimits: Set/Get new restart limits for a plugin
+        // @brief Set/Get new restart limits for a plugin
         // @param callsign: Callsign of the plugin
         // @param params: Restart Information
         virtual Core::hresult RestartLimits(const string& callsign /* @index */, const RestartInfo& params) = 0;
         virtual Core::hresult RestartLimits(const string& callsign /* @index */, RestartInfo& params /* @out */) const = 0;
 
-        // @brief ResetStats: Resets memory for a single plugin watched by the Monitor
+        // @brief Resets memory for a single plugin watched by the Monitor
         virtual Core::hresult Reset(const string& callsign) = 0;
 
         // @property
-        // @brief Observables: List of plugins watched by the Monitor
+        // @brief List of plugins watched by the Monitor
+        // @param observables: list of plugins name monitoring by this plugin
         virtual Core::hresult Observables(IStringIterator*& observables /* @out */) const = 0;
         // @property
-        // @brief Statistics: The memory and process statistics either for a given plugin
+        // @brief The memory and process statistics either for a given plugin
+        // @param callsign: Callsign of the plugin
+        // @param statistics: Statistics for the requested plugin
         virtual Core::hresult StatisticsInfo(const string& callsign /* @index */, Statistics& statistics /* @out */) const = 0;
     };
 }

diff --git a/interfaces/IOCDM.h b/interfaces/IOCDM.h
@@ -402,10 +402,10 @@ struct EXTERNAL IOCDM : virtual public Core::IUnknown {
     using IStringIterator = RPC::IIteratorType<string, RPC::ID_STRINGITERATOR>;
 
     // @property
-    // @brief Systems - Retrieves all key systems available in the system (e.g. Nagra, PlayReady, WideVine etc)
+    // @brief Retrieves all key systems available in the system (e.g. Nagra, PlayReady, WideVine etc)
     virtual Core::hresult Systems(IStringIterator*& drms /* @out */) const = 0;
     // @property
-    // @brief Designators - Retrieves all designators associated with a Key System (Nagra, PlayReady, WideVine).
+    // @brief Retrieves all designators associated with a Key System (Nagra, PlayReady, WideVine).
     virtual Core::hresult Designators(const string& drm /* @index */, IStringIterator*& keys /* @out */) const = 0;
 };