diff options
Diffstat (limited to 'doc/classes/JSONRPC.xml')
| -rw-r--r-- | doc/classes/JSONRPC.xml | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/classes/JSONRPC.xml b/doc/classes/JSONRPC.xml index e8fb208fef..8af4ed1f26 100644 --- a/doc/classes/JSONRPC.xml +++ b/doc/classes/JSONRPC.xml @@ -15,8 +15,8 @@ <param index="1" name="params" type="Variant" /> <description> Returns a dictionary in the form of a JSON-RPC notification. Notifications are one-shot messages which do not expect a response. - - [code]method[/code]: Name of the method being called. - - [code]params[/code]: An array or dictionary of parameters being passed to the method. + - [param method]: Name of the method being called. + - [param params]: An array or dictionary of parameters being passed to the method. </description> </method> <method name="make_request"> @@ -26,9 +26,9 @@ <param index="2" name="id" type="Variant" /> <description> Returns a dictionary in the form of a JSON-RPC request. Requests are sent to a server with the expectation of a response. The ID field is used for the server to specify which exact request it is responding to. - - [code]method[/code]: Name of the method being called. - - [code]params[/code]: An array or dictionary of parameters being passed to the method. - - [code]id[/code]: Uniquely identifies this request. The server is expected to send a response with the same ID. + - [param method]: Name of the method being called. + - [param params]: An array or dictionary of parameters being passed to the method. + - [param id]: Uniquely identifies this request. The server is expected to send a response with the same ID. </description> </method> <method name="make_response"> @@ -37,8 +37,8 @@ <param index="1" name="id" type="Variant" /> <description> When a server has received and processed a request, it is expected to send a response. If you did not want a response then you need to have sent a Notification instead. - - [code]result[/code]: The return value of the function which was called. - - [code]id[/code]: The ID of the request this response is targeted to. + - [param result]: The return value of the function which was called. + - [param id]: The ID of the request this response is targeted to. </description> </method> <method name="make_response_error" qualifiers="const"> @@ -48,9 +48,9 @@ <param index="2" name="id" type="Variant" default="null" /> <description> Creates a response which indicates a previous reply has failed in some way. - - [code]code[/code]: The error code corresponding to what kind of error this is. See the [enum ErrorCode] constants. - - [code]message[/code]: A custom message about this error. - - [code]id[/code]: The request this error is a response to. + - [param code]: The error code corresponding to what kind of error this is. See the [enum ErrorCode] constants. + - [param message]: A custom message about this error. + - [param id]: The request this error is a response to. </description> </method> <method name="process_action"> @@ -60,7 +60,7 @@ <description> Given a Dictionary which takes the form of a JSON-RPC request: unpack the request and run it. Methods are resolved by looking at the field called "method" and looking for an equivalently named function in the JSONRPC object. If one is found that method is called. To add new supported methods extend the JSONRPC class and call [method process_action] on your subclass. - [code]action[/code]: The action to be run, as a Dictionary in the form of a JSON-RPC request or notification. + [param action]: The action to be run, as a Dictionary in the form of a JSON-RPC request or notification. </description> </method> <method name="process_string"> |