From 8be1baf7322dd1b05f02e1a2e09087df05ff9d0c Mon Sep 17 00:00:00 2001 From: Micky Date: Wed, 10 Jan 2024 16:52:47 +0100 Subject: [PATCH] Add miscellaneous documentation to some classes --- doc/classes/EditorExportPlatformPC.xml | 3 +++ doc/classes/JSONRPC.xml | 4 ++++ platform/android/doc_classes/EditorExportPlatformAndroid.xml | 1 + platform/windows/doc_classes/EditorExportPlatformWindows.xml | 1 + 4 files changed, 9 insertions(+) diff --git a/doc/classes/EditorExportPlatformPC.xml b/doc/classes/EditorExportPlatformPC.xml index 3c2a27deabc..def14e59552 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). + 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. + $DOCS_URL/tutorials/export/exporting_for_windows.html + $DOCS_URL/tutorials/export/exporting_for_linux.html diff --git a/doc/classes/JSONRPC.xml b/doc/classes/JSONRPC.xml index 348688f7f84..e5ee93cb931 100644 --- a/doc/classes/JSONRPC.xml +++ b/doc/classes/JSONRPC.xml @@ -79,15 +79,19 @@ + The request could not be parsed as it was not valid by JSON standard ([method JSON.parse] failed). + A method call was requested but the request's format is not valid. A method call was requested but no function of that name existed in the JSONRPC subclass. + A method call was requested but the given method parameters are not valid. Not used by the built-in JSONRPC. + An internal error occurred while processing the request. Not used by the built-in JSONRPC. diff --git a/platform/android/doc_classes/EditorExportPlatformAndroid.xml b/platform/android/doc_classes/EditorExportPlatformAndroid.xml index dae968378b8..9a62a5bd122 100644 --- a/platform/android/doc_classes/EditorExportPlatformAndroid.xml +++ b/platform/android/doc_classes/EditorExportPlatformAndroid.xml @@ -590,6 +590,7 @@ Application version visible to the user. Falls back to [member ProjectSettings.application/config/version] if left empty. + The extended reality (XR) mode for this application. diff --git a/platform/windows/doc_classes/EditorExportPlatformWindows.xml b/platform/windows/doc_classes/EditorExportPlatformWindows.xml index 2a286de100b..7ad419e0773 100644 --- a/platform/windows/doc_classes/EditorExportPlatformWindows.xml +++ b/platform/windows/doc_classes/EditorExportPlatformWindows.xml @@ -4,6 +4,7 @@ Exporter for Windows. + The Windows exporter customizes how a Windows build is handled. In the editor's "Export" window, it is created when adding a new "Windows" preset. $DOCS_URL/tutorials/export/exporting_for_windows.html