Skip to content

Commit 569b9ba

Browse files
MFransen69volkan-aslan
authored andcommitted
[Docs] add correct links to release notes for 5.3 (#2027)
1 parent 7e4b93c commit 569b9ba

File tree

2 files changed

+8
-15
lines changed

2 files changed

+8
-15
lines changed

ReleaseNotes/ThunderReleaseNotes_R5.3.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,7 @@ As this is a relatively new but potentially complex feature, the Thunder documen
5050
Before Thunder 5.3 error codes used in Thunder were predefined, which sufficed up to now. These error codes (due to the "JSON-RPC in terms of COM-RPC" feature) are also translated into JSON-RPC error codes and there was a request to support a more flexible error scheme (mainly to have more flexibility in the error codes reported in the JSON-RPC error object).
5151
So with this new Custom Codes feature a mechanism was introduced to have custom error codes that are consistent for both COM-RPC and JSON-RPC (or any other future protocol that will be implemented in terms of COM-RPC), allow for custom (not hardcoded inside Thunder) code to string translation and allow for direct influence on the error code returned by JSON-RPC.
5252

53-
For more info see [here]() in the Thunder documentation.
54-
55-
NOTE self: add link above
53+
For more info see [here](https://rdkcentral.github.io/Thunder/utils/customcodes/) in the Thunder documentation.
5654

5755
### Feature: Warning reporting for WebSocket open and close
5856

@@ -109,7 +107,7 @@ The class can be found [here](https://github.com/rdkcentral/Thunder/blob/d57c034
109107

110108
### Feature: Enable to reach remote plugin via the Composite plugin feature
111109

112-
Thunder now fully supports accessing a Plugin living in a remote Thunder instance to be made accessible in the local Thunder instance using the Composite plugin feature (see also the new BridgeLink plugin in the ThunderNanoServicesRDK repository, read the release notes for that here NOTE hier nog link toevoegen)
110+
Thunder now fully supports accessing a Plugin living in a remote Thunder instance to be made accessible in the local Thunder instance using the Composite plugin feature (see also the new BridgeLink plugin in the ThunderNanoServicesRDK repository, read the release notes for that [here](https://github.com/WebPlatformForEmbedded/ThunderNanoServicesRDK/blob/master/ReleaseNotes/ThunderReleaseNotes_R5.3_rdkservices.md) )
113111

114112
The ThunderUI has also been updated to support this feature and will now also show the remote plugins now.
115113

@@ -240,17 +238,16 @@ Although the old dot format was in use only for a short time in Thunder 5 the @i
240238

241239
Indexes now also support OptionalType indexes to indicate subscribing to the index or all is in principle optional. For this to work it is now also allowed to put the @index keyword at the Register and the event is then looked up by name of the indexed parameter.
242240
(it is also allowed and advised to also put the @index then at the Unregister)
243-
Please see this section in the Thunder documentation that has been added to describe indexed events: NOTE: add link
241+
Please see [this section](https://rdkcentral.github.io/Thunder/plugin/interfaces/interfaces/#indexed-events) in the Thunder documentation that has been added to describe indexed events.
244242

245243
### Change: auto object lookup now requires @encode:autolookup
246244

247245
The JSON-RPC auto object lookup feature now requires the @encode:autolookup tag, this for improved detection and consistency.
248-
See more [here]() NOTE self: add link to autolookup documentation section.
249246
Note the auto object lookup feature was introduced in Thunder 5.2 without needing @encode:autolookup to be specified (it should not be breaking as Thunder 5.2 was not used to define new object based JSON-RPC interfaces with auto object lookup).
250247

251248
A new feature for the auto object lookup is that it is now possible to register callbacks to be called when objects are acquired or relinquished in case special handling is needed for JSON-RPC (generic code can be put into the COM-RPC code for Acquire and Relinquish as that is called for both cases).
252249

253-
The (updated) documentation can be found [here]() NOTE: update link
250+
The (updated) documentation can be found [here](https://rdkcentral.github.io/Thunder/plugin/interfaces/interfaces/#object-lookup)
254251

255252
### Feature: support custom object lookup
256253

@@ -259,9 +256,7 @@ Where auto lookup takes care of the creation of object ID's and linking them to
259256
This makes it easier for clients as the now can use a more meaningful ID instead of the abstract ID created by autolookup.
260257
Custom lookup is indicated by specifying the @encode:lookup with the interface for the object type.
261258

262-
See the Thunder documentation for more info [here]()
263-
264-
NOTE: link to be included
259+
See the Thunder documentation for more info [here](https://rdkcentral.github.io/Thunder/plugin/interfaces/interfaces/#custom-object-lookup)
265260

266261
### Feature: support status listeners for lookup objects
267262

@@ -284,12 +279,10 @@ Note: see [here](https://rdkcentral.github.io/Thunder/plugin/devtools/pluginskel
284279

285280
### Feature: wrapped format
286281

287-
The newly added wrapped tag will for a single output parameter also add the parameter name to the result, making it always a JSON object. It can also be used for arrays, std::vector, iterator etc. (see for more info [here]()) NOTE add link after documentation published
282+
The newly added wrapped tag will for a single output parameter also add the parameter name to the result, making it always a JSON object. It can also be used for arrays, std::vector, iterator etc.
288283
Of course it is preferable to keep the JSON-RPC interface as whole consistent but this was added as there are interface where workarounds are used to achieve the wrapped effect so having this tag will make it easier to achieve the wrapped format.
289284

290-
See here for more info;
291-
292-
NOTE: add link to documentation.
285+
See [here](https://rdkcentral.github.io/Thunder/plugin/interfaces/tags/#wrapped) for more info.
293286

294287
### Feature: new buffer encoding options
295288

docs/plugin/interfaces/tags.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -639,7 +639,7 @@ Example list:
639639

640640
<hr>
641641

642-
#### Wrapped
642+
#### @wrapped
643643

644644
This tag can be placed at class or method level, where at class level is by far preferable as it prevents inconsistencies in JSON-RPC function handling.
645645
Wrapped will for a single output parameter also add the parameter name to the result, making it always a JSON object.

0 commit comments

Comments
 (0)