Make small improvement to SDL_PropertiesID documentation #14170
+5
−1
Conversation
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
|
😵💫 |
|
This seems useful, but maybe there's a better way to link to the categories so it'll work from the headers. @icculus, thoughts? |
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.
Description
Some places in the documentation (e.g.
SDL_CreateProcessWithProperties) will show that the function takes anSDL_PropertiesIDargument, then link to theSDL_PropertiesIDtype which helpfully informs you that it is an int. That's it.I added links to places that can help people get started with understanding how to create property groups that can be passed to these functions, in case people end up at this page via some other API documentation that assumes they understand property groups already.