Add getControllerWorldLocation to apidocs#2171
Open
zedwick wants to merge 1 commit intooverte-org:masterfrom
Open
Add getControllerWorldLocation to apidocs#2171zedwick wants to merge 1 commit intooverte-org:masterfrom
zedwick wants to merge 1 commit intooverte-org:masterfrom
Conversation
* JSDoc will now include scripts/modules and scripts/system/libraries * Fixes overte-org#124
zedwick
added
documentation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Before this PR it seems no scripts libraries or modules were included in the apidocs. This is the first step to resolving this.
scripts/modulesandscripts/system/libraries..jsfiles/*@jsdocsyntax as in the c++ files, rather than/**, to start their commentsscripts/system/libraries/controllers.jshas been documented, with its own page in the API docs.I made sure to document how to include the library at the top of the file, as it works differently to the other APIs.
Resolves #124