summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2024-04-08 11:19:33 +0200
committerRémi Verschelde <rverschelde@gmail.com>2024-04-08 11:19:33 +0200
commit6b4944ee679d9fdf7349a8bfafed026a64678d31 (patch)
treeaecf82016766b03785b37ea99bd3cfa8ac63873a /doc
parentd250e6dba658e49870d7bf08bdf461f4c6837891 (diff)
parent8be1baf7322dd1b05f02e1a2e09087df05ff9d0c (diff)
downloadredot-engine-6b4944ee679d9fdf7349a8bfafed026a64678d31.tar.gz
Merge pull request #87042 from Mickeon/documentation-EditorExportPlatform-misc
Add miscellaneous documentation to some classes
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/EditorExportPlatformPC.xml3
-rw-r--r--doc/classes/JSONRPC.xml4
2 files changed, 7 insertions, 0 deletions
diff --git a/doc/classes/EditorExportPlatformPC.xml b/doc/classes/EditorExportPlatformPC.xml
index 3c2a27deab..def14e5955 100644
--- a/doc/classes/EditorExportPlatformPC.xml
+++ b/doc/classes/EditorExportPlatformPC.xml
@@ -4,7 +4,10 @@
Base class for the desktop platform exporter (Windows and Linux/BSD).
</brief_description>
<description>
+ The base class for the desktop platform exporters. These include Windows and Linux/BSD, but not macOS. See the classes inheriting this one for more details.
</description>
<tutorials>
+ <link title="Exporting for Windows">$DOCS_URL/tutorials/export/exporting_for_windows.html</link>
+ <link title="Exporting for Linux">$DOCS_URL/tutorials/export/exporting_for_linux.html</link>
</tutorials>
</class>
diff --git a/doc/classes/JSONRPC.xml b/doc/classes/JSONRPC.xml
index 348688f7f8..e5ee93cb93 100644
--- a/doc/classes/JSONRPC.xml
+++ b/doc/classes/JSONRPC.xml
@@ -79,15 +79,19 @@
</methods>
<constants>
<constant name="PARSE_ERROR" value="-32700" enum="ErrorCode">
+ The request could not be parsed as it was not valid by JSON standard ([method JSON.parse] failed).
</constant>
<constant name="INVALID_REQUEST" value="-32600" enum="ErrorCode">
+ A method call was requested but the request's format is not valid.
</constant>
<constant name="METHOD_NOT_FOUND" value="-32601" enum="ErrorCode">
A method call was requested but no function of that name existed in the JSONRPC subclass.
</constant>
<constant name="INVALID_PARAMS" value="-32602" enum="ErrorCode">
+ A method call was requested but the given method parameters are not valid. Not used by the built-in JSONRPC.
</constant>
<constant name="INTERNAL_ERROR" value="-32603" enum="ErrorCode">
+ An internal error occurred while processing the request. Not used by the built-in JSONRPC.
</constant>
</constants>
</class>