Add documentation generation for in-engine display #115
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To generate in-engine documentation for the Wwise integration classes: 1) Run a Godot project with the Wwise integration from the command line, adding the --doctool parameter. This tool will generate XML files containing the classes from the engine, including those from the Wwise integration. 2) Move the classes you want to include in the Wwise integration's in-engine documentation to addons/Wwise/native/doc_classes. Edit these XML files directly to add documentation for the classes. 3) Rebuild the integration with the target set to editor. The documentation will now appear in the engine. In this commit, documentation for the Wwise and Waapi singletons has been added.
alessandrofama
added a commit
that referenced
this pull request
Nov 21, 2024
To generate in-engine documentation for the Wwise integration classes: 1) Run a Godot project with the Wwise integration from the command line, adding the --doctool parameter. This tool will generate XML files containing the classes from the engine, including those from the Wwise integration. 2) Move the classes you want to include in the Wwise integration's in-engine documentation to addons/Wwise/native/doc_classes. Edit these XML files directly to add documentation for the classes. 3) Rebuild the integration with the target set to editor. The documentation will now appear in the engine. In this commit, documentation for the Wwise and Waapi singletons has been added.
alessandrofama
added a commit
that referenced
this pull request
Nov 21, 2024
(cherry picked from commit f06f7d)
alessandrofama
added a commit
that referenced
this pull request
Nov 21, 2024
(cherry picked from commit f06f7d0)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To generate in-engine documentation for the Wwise integration classes:
Run a Godot project with the Wwise integration from the command line, adding the --doctool parameter. This tool will generate XML files containing the classes from the engine, including those from the Wwise integration.
Move the classes you want to include in the Wwise integration's in-engine documentation to addons/Wwise/native/doc_classes. Edit these XML files directly to add documentation for the classes.
Rebuild the integration with the target set to editor. The documentation will now appear in the engine.
In this commit, documentation for the Wwise and Waapi singletons has been added.