[docs] : add 'guidelines' in 'plugins/interfaces' (#1721)

* [docs] : add 'guidelines' in 'plugins/interfaces' * [Documentation] small update * [doc] add practical part 1 * [doc] small fixes to new guideliness section * [doc] add queryinterface example to practicalities section * [doc] add more sections to interface guideliness * [doc] fix interface guidelines links * [doc] update interface guideliness after review P. Wielders * [Documentation] Update interface guideliness * [doc] move files to assets --------- Co-authored-by: Marcel Fransen <[email protected]> Co-authored-by: MFransen69 <[email protected]>
rdkcentral · Sep 12, 2024 · f6e5980 · f6e5980
1 parent a0a7547
commit f6e5980
Show file tree

Hide file tree

Showing 6 changed files with 462 additions and 0 deletions.
diff --git a/docs/assets/AsyncInterfaceExample.png b/docs/assets/AsyncInterfaceExample.png
diff --git a/docs/assets/ExampleStaticDynamic1.png b/docs/assets/ExampleStaticDynamic1.png
diff --git a/docs/assets/ExampleStaticDynamic2.png b/docs/assets/ExampleStaticDynamic2.png
diff --git a/docs/assets/umlsources.txt b/docs/assets/umlsources.txt
@@ -0,0 +1,55 @@
+plantuml
+
+@startuml
+
+skin rose
+
+participant Plugin order 30
+
+Client1 -> Plugin: SetA(10)
+CLient2 -> Plugin: GetA()
+CLient2 -> Plugin: GetB()
+Client1 -> Plugin: SetB(20)
+
+
+@enduml
+
+
+@startuml
+
+skin rose
+
+participant Plugin order 30
+
+Client1 -> Plugin: SetA(10)
+Activate Plugin
+Plugin -> Client3: AChanged()
+Activate Client3
+Client2 -> Plugin: SetA(20)
+Client3 -> Plugin: GetA()
+Deactivate Client3
+Plugin --> Client1
+Deactivate Plugin
+
+@enduml
+
+@startuml
+
+skin rose
+
+participant Plugin order 30
+participant PinProvider order 40
+
+Client -> Plugin: GetPin(Callback)
+Plugin --> Client
+Plugin -> Plugin: GetPin
+Activate Plugin
+Plugin -> PinProvider: RetrievePin
+Activate PinProvider
+PinProvider --> Plugin: pin
+Deactivate PinProvider
+Plugin -> Client: Callback(pin)
+Deactivate Plugin
+
+
+@enduml