Skip to content

Commit

Permalink
Merge pull request #87042 from Mickeon/documentation-EditorExportPlat…
Browse files Browse the repository at this point in the history
…form-misc

Add miscellaneous documentation to some classes
  • Loading branch information
akien-mga committed Apr 8, 2024
2 parents d250e6d + 8be1baf commit 6b4944e
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/classes/EditorExportPlatformPC.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
4 changes: 4 additions & 0 deletions doc/classes/JSONRPC.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Original file line number Diff line number Diff line change
Expand Up @@ -595,6 +595,7 @@
Application version visible to the user. Falls back to [member ProjectSettings.application/config/version] if left empty.
</member>
<member name="xr_features/xr_mode" type="int" setter="" getter="">
The extended reality (XR) mode for this application.
</member>
</members>
</class>
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
Exporter for Windows.
</brief_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>
<tutorials>
<link title="Exporting for Windows">$DOCS_URL/tutorials/export/exporting_for_windows.html</link>
Expand Down

0 comments on commit 6b4944e

Please sign in to comment.