Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enum members manually added to header categories do not appear in those categories #697

Open
Susko3 opened this issue Jan 9, 2025 · 2 comments
Assignees

Comments

@Susko3
Copy link
Contributor

Susko3 commented Jan 9, 2025

Enum members, like SDL_EVENT_PEN_BUTTON_DOWN can be manually added to categories, e.g. by adding CategoryPen to the page.

These enum members unfortunately won't show up on the category page. I think this is because they are tagged as CategoryAPIEnumerators, which doesn't appear in the auto-generated category page (closest is CategoryAPIEnum).

To fix this, you could change enum members to be in the CategoryAPIEnum, or, better yet, add a new section on the category page just for enum members, re-using the existing CategoryAPIEnumerators.


Please note that I'm not asking to automatically add enum members to categories based on their header files, that might produce too much noise on the category pages, especially for enums with lost of members (but perhaps an exhaustive list is what you want).

@icculus icculus self-assigned this Jan 9, 2025
@icculus
Copy link
Contributor

icculus commented Jan 9, 2025

This was intentional, so the list of enums on the category pages would only be typedefs (SDL_Keycode listed, its 251 subitems not listed). But if a separate section for these on the category pages is desirable, we could do it. I'm not certain it is desirable, though, as these pages were only generated so the symbols had a wiki page at all.

@Susko3
Copy link
Contributor Author

Susko3 commented Jan 9, 2025

I originally wanted to improve the CategoryPen page by including the relevant events. Right now, there's only a dead link to SDL_EVENT_PEN_*, I thought a list of the pen events would be useful, and adding them to the category made sense.

Maybe it's easier to add this list manually, or say it in prose "simply handle SDL_EVENT_PEN_* events". The SDL_EventType page is not the easiest to navigate, but it leads to the correct place and is not a dead link.

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

No branches or pull requests

2 participants