Skip to content

Conversation

TheMadman
Copy link
Contributor

Description

Some places in the documentation (e.g. SDL_CreateProcessWithProperties) will show that the function takes an SDL_PropertiesID argument, then link to the SDL_PropertiesID type 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.

@TheMadman
Copy link
Contributor Author

😵‍💫

@slouken
Copy link
Collaborator

slouken commented Oct 7, 2025

This seems useful, but maybe there's a better way to link to the categories so it'll work from the headers. @icculus, thoughts?

@slouken slouken modified the milestones: 3.x, 3.4.0 Oct 7, 2025
@slouken slouken requested a review from icculus October 12, 2025 22:50
@icculus
Copy link
Collaborator

icculus commented Oct 13, 2025

So the category docs are linked from that page already, but it's probably too subtle to be useful.

We could add a wiki-only section (anything in a ## Whatever String We Want section will be preserved on the wiki and not migrate to the headers, as long as the title isn't a standard thing like "Remarks", etc).

@icculus
Copy link
Collaborator

icculus commented Oct 13, 2025

Something like:

## Using Properties

While this just looks like an integer to the application, SDL properties are actually
key/value stores that can manage sets of information with multiple datatypes.

Please refer to [CategoryProperties](CategoryProperties) for all the details.

@icculus
Copy link
Collaborator

icculus commented Oct 13, 2025

I went ahead and did this in libsdl-org/sdlwiki@67e2c99.

@icculus icculus closed this Oct 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants