Skip to content

Commit 193258b

Browse files
authored
Merge pull request #3737 from dingodoppelt/fix_rpc_docs_tool
Fix extra space generated by "generate_json_rpc_docs.py"
2 parents a90bb9f + 63a47e6 commit 193258b

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

docs/JSON-RPC.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ Results:
258258

259259
### jamulusclient/setFaderLevel
260260

261-
Sets the fader level. Example: {"id":1,"jsonrpc":"2.0","method":"jamulusclient/setFaderLevel","params":{"channelIndex": 0,"level": 50}}.
261+
Sets the fader level. Example: {"id":1,"jsonrpc":"2.0","method":"jamulusclient/setFaderLevel","params":{"channelIndex": 0,"level": 50}}.
262262

263263
Parameters:
264264

@@ -391,7 +391,7 @@ Results:
391391
| result.countryId | number | The server country ID (see QLocale::Country). |
392392
| result.welcomeMessage | string | The server welcome message. |
393393
| result.directoryType | string | The directory type as a string (see EDirectoryType and SerializeDirectoryType). |
394-
| result.directoryAddress | string | The string used to look up the directory address (only assume valid if directoryType is "custom" and registrationStatus is "registered"). |
394+
| result.directoryAddress | string | The string used to look up the directory address (only assume valid if directoryType is "custom" and registrationStatus is "registered"). |
395395
| result.directory | string | The directory with which this server requested registration, or blank if none. |
396396
| result.registrationStatus | string | The server registration status as string (see ESvrRegStatus and SerializeRegistrationStatus). |
397397

@@ -410,7 +410,7 @@ Results:
410410

411411
| Name | Type | Description |
412412
| --- | --- | --- |
413-
| result | string | Always "acknowledged". To check if the recording was restarted or if there is any error, call `jamulusserver/getRecorderStatus` again. |
413+
| result | string | Always "acknowledged". To check if the recording was restarted or if there is any error, call `jamulusserver/getRecorderStatus` again. |
414414

415415

416416
### jamulusserver/setDirectory
@@ -445,7 +445,7 @@ Results:
445445

446446
| Name | Type | Description |
447447
| --- | --- | --- |
448-
| result | string | Always "acknowledged". To check if the directory was changed, call `jamulusserver/getRecorderStatus` again. |
448+
| result | string | Always "acknowledged". To check if the directory was changed, call `jamulusserver/getRecorderStatus` again. |
449449

450450

451451
### jamulusserver/setServerName
@@ -496,7 +496,7 @@ Results:
496496

497497
| Name | Type | Description |
498498
| --- | --- | --- |
499-
| result | string | Always "acknowledged". To check if the recording was enabled, call `jamulusserver/getRecorderStatus` again. |
499+
| result | string | Always "acknowledged". To check if the recording was enabled, call `jamulusserver/getRecorderStatus` again. |
500500

501501

502502
### jamulusserver/stopRecording
@@ -513,7 +513,7 @@ Results:
513513

514514
| Name | Type | Description |
515515
| --- | --- | --- |
516-
| result | string | Always "acknowledged". To check if the recording was disabled, call `jamulusserver/getRecorderStatus` again. |
516+
| result | string | Always "acknowledged". To check if the recording was disabled, call `jamulusserver/getRecorderStatus` again. |
517517

518518

519519
## Notification reference
@@ -525,7 +525,7 @@ Parameters:
525525

526526
| Name | Type | Description |
527527
| --- | --- | --- |
528-
| params.channelLevelList | array | The channel level list. Each item corresponds to the respective client retrieved from the jamulusclient/clientListReceived notification. |
528+
| params.channelLevelList | array | The channel level list. Each item corresponds to the respective client retrieved from the jamulusclient/clientListReceived notification. |
529529
| params.channelLevelList[*] | number | The channel level, an integer between 0 and 9. |
530530

531531

tools/generate_json_rpc_docs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ def to_markdown(self):
219219
current_item.handle_tag("result")
220220
current_item.handle_text(line[len("/// @result "):])
221221
elif line.startswith("///"):
222-
current_item.handle_text(line[len("///"):])
222+
current_item.handle_text(line[len("///"):].lstrip())
223223
elif line == "":
224224
pass
225225
else:

0 commit comments

Comments
 (0)