Set appropriate default instance names for the 'syntax' section #6
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.
Many core libraries (such as Hardware I/O, Video and Sound) lack
@instanceName
annotations on their classes, which leads to misleading 'syntax' sections of their method references already noted in processing/processing-website#397 (see e.g.movieObject.available()
) which only look like:Those classes which do have an explicit
@instanceName
annotation (such as the Serial library) use the same instance name and description for static methods, which is also misleading (e.g. in the case ofSerial.list()
):This pull request sets a non-empty default instance name which is the exact class name (for static methods) or a lower case version of the class name (for instance methods). If desired it would also be possible to add a default instance description that follows the conventions of the Processing core classes or Serial library ("any object/variable of type ...")