godot/doc/classes/JSONRPC.xml
Rémi Verschelde 7adf4cc9b5
doc: Use self-closing tags for return and argument
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
2021-07-30 15:29:52 +02:00

74 lines
2.2 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="JSONRPC" inherits="Object" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="make_notification">
<return type="Dictionary" />
<argument index="0" name="method" type="String" />
<argument index="1" name="params" type="Variant" />
<description>
</description>
</method>
<method name="make_request">
<return type="Dictionary" />
<argument index="0" name="method" type="String" />
<argument index="1" name="params" type="Variant" />
<argument index="2" name="id" type="Variant" />
<description>
</description>
</method>
<method name="make_response">
<return type="Dictionary" />
<argument index="0" name="result" type="Variant" />
<argument index="1" name="id" type="Variant" />
<description>
</description>
</method>
<method name="make_response_error" qualifiers="const">
<return type="Dictionary" />
<argument index="0" name="code" type="int" />
<argument index="1" name="message" type="String" />
<argument index="2" name="id" type="Variant" default="null" />
<description>
</description>
</method>
<method name="process_action">
<return type="Variant" />
<argument index="0" name="action" type="Variant" />
<argument index="1" name="recurse" type="bool" default="false" />
<description>
</description>
</method>
<method name="process_string">
<return type="String" />
<argument index="0" name="action" type="String" />
<description>
</description>
</method>
<method name="set_scope">
<return type="void" />
<argument index="0" name="scope" type="String" />
<argument index="1" name="target" type="Object" />
<description>
</description>
</method>
</methods>
<constants>
<constant name="PARSE_ERROR" value="-32700" enum="ErrorCode">
</constant>
<constant name="INVALID_REQUEST" value="-32600" enum="ErrorCode">
</constant>
<constant name="METHOD_NOT_FOUND" value="-32601" enum="ErrorCode">
</constant>
<constant name="INVALID_PARAMS" value="-32602" enum="ErrorCode">
</constant>
<constant name="INTERNAL_ERROR" value="-32603" enum="ErrorCode">
</constant>
</constants>
</class>