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

Update doc comment on FixedResolutionViewport #3131

Closed
1 task
kevmoo opened this issue Apr 18, 2024 · 0 comments · Fixed by #3132
Closed
1 task

Update doc comment on FixedResolutionViewport #3131

kevmoo opened this issue Apr 18, 2024 · 0 comments · Fixed by #3132

Comments

@kevmoo
Copy link
Contributor

kevmoo commented Apr 18, 2024

What could be improved

/// [FixedAspectRatioViewport] is a rectangular viewport which auto-expands to
/// take as much space as possible within the canvas, while maintaining a fixed
/// aspect ratio.
///
/// This viewport will automatically adjust its size and position when the
/// game canvas changes in size. At the same time, manually changing the size
/// of this viewport is not supported.
class FixedResolutionViewport extends FixedAspectRatioViewport

This doc comment looks copy-pasted from the super type

Why should this be improved

Might be good to document the features of this class

Risks

No response

More information

No response

Other

  • Are you interested in working on a PR for this?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant