Add miscellaneous documentation to some classes

This commit is contained in:
Micky 2024-01-10 16:52:47 +01:00
parent 3524346689
commit 8be1baf732
4 changed files with 9 additions and 0 deletions

View File

@ -4,7 +4,10 @@
Base class for the desktop platform exporter (Windows and Linux/BSD). Base class for the desktop platform exporter (Windows and Linux/BSD).
</brief_description> </brief_description>
<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> </description>
<tutorials> <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> </tutorials>
</class> </class>

View File

@ -79,15 +79,19 @@
</methods> </methods>
<constants> <constants>
<constant name="PARSE_ERROR" value="-32700" enum="ErrorCode"> <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>
<constant name="INVALID_REQUEST" value="-32600" enum="ErrorCode"> <constant name="INVALID_REQUEST" value="-32600" enum="ErrorCode">
A method call was requested but the request's format is not valid.
</constant> </constant>
<constant name="METHOD_NOT_FOUND" value="-32601" enum="ErrorCode"> <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. A method call was requested but no function of that name existed in the JSONRPC subclass.
</constant> </constant>
<constant name="INVALID_PARAMS" value="-32602" enum="ErrorCode"> <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>
<constant name="INTERNAL_ERROR" value="-32603" enum="ErrorCode"> <constant name="INTERNAL_ERROR" value="-32603" enum="ErrorCode">
An internal error occurred while processing the request. Not used by the built-in JSONRPC.
</constant> </constant>
</constants> </constants>
</class> </class>

View File

@ -590,6 +590,7 @@
Application version visible to the user. Falls back to [member ProjectSettings.application/config/version] if left empty. Application version visible to the user. Falls back to [member ProjectSettings.application/config/version] if left empty.
</member> </member>
<member name="xr_features/xr_mode" type="int" setter="" getter=""> <member name="xr_features/xr_mode" type="int" setter="" getter="">
The extended reality (XR) mode for this application.
</member> </member>
</members> </members>
</class> </class>

View File

@ -4,6 +4,7 @@
Exporter for Windows. Exporter for Windows.
</brief_description> </brief_description>
<description> <description>
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.
</description> </description>
<tutorials> <tutorials>
<link title="Exporting for Windows">$DOCS_URL/tutorials/export/exporting_for_windows.html</link> <link title="Exporting for Windows">$DOCS_URL/tutorials/export/exporting_for_windows.html</link>