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

[Doxy] Improve documentation of game windows #24079

Merged
merged 4 commits into from Nov 14, 2023
Merged

Conversation

garbear
Copy link
Member

@garbear garbear commented Nov 10, 2023

Description

This PR adds missing game classes to the Games topic and then improves documentation for the following windows:

Motivation and context

Skinners are looking for more information about how the game windows work as they update their skins for Nexus/Omega.

How has this been tested?

See above links to rendered documentation (and note, it was built with an old version of doxygen that has some problems like the A links)

What is the effect on users?

  • Improved game documentation for developers

Types of change

  • Bug fix (non-breaking change which fixes an issue)
  • Clean up (non-breaking change which removes non-working, unmaintained functionality)
  • Improvement (non-breaking change which improves existing functionality)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that will cause existing functionality to change)
  • Cosmetic change (non-breaking change that doesn't touch code)
  • Student submission (PR was done for educational purposes and will be treated as such)
  • None of the above (please explain below)

@garbear garbear added Type: Improvement non-breaking change which improves existing functionality Component: Games Component: Documentation v21 Omega labels Nov 10, 2023
@garbear garbear added this to the Omega 21.0 Beta 2 milestone Nov 10, 2023
@garbear
Copy link
Member Author

garbear commented Nov 14, 2023

jenkins build this please

@garbear
Copy link
Member Author

garbear commented Nov 14, 2023

Jenkins ain't happy, but this only affect comments so in it goes.

@garbear garbear merged commit 543d226 into xbmc:master Nov 14, 2023
1 of 2 checks passed
@garbear garbear deleted the doxygen-games branch November 14, 2023 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation Component: Games Type: Improvement non-breaking change which improves existing functionality v21 Omega
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant