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.

Sign up for GitHub

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

Jump to bottom

In-code Documentation Update #239

Merged
merged 1 commit into from
Feb 17, 2024
Merged

In-code Documentation Update #239

merged 1 commit into from
Feb 17, 2024

Conversation

DemoXinMC
Copy link
Contributor

This is an absolute doozy of a diff, but it's all within comments and doesn't include any actual code changes. It also adds clarity to a couple of quirks that are discussed in #194 and #195

  • Addresses requests in New Textures aren't zeroed #194 and VertexArray indexer doesnt returns a reference #195
  • Updated all [Obsolete] attributes to be less repetitive
  • Added a large number of quick reference links to existing summaries
  • Corrected various typos and unparsable markup(\a and \p)
  • Added additional formatting to numerous summaries, resulting in more readable tooltips
  • Added a suggestion to use TimeSpan over SFML's Time while working within a managed environment

@eXpl0it3r eXpl0it3r added the Docs label Jan 4, 2024
eXpl0it3r
eXpl0it3r requested changes Jan 4, 2024
View reviewed changes
Copy link
Member

@eXpl0it3r eXpl0it3r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love the PR! 🙂
A few minor adjustments

src/SFML.Graphics/RenderTexture.cs Show resolved Hide resolved
src/SFML.Graphics/Shader.cs Show resolved Hide resolved
src/SFML.Graphics/Text.cs Outdated Show resolved Hide resolved
src/SFML.Graphics/Text.cs Outdated Show resolved Hide resolved
src/SFML.Graphics/Text.cs Outdated Show resolved Hide resolved
src/SFML.Graphics/VertexArray.cs Outdated Show resolved Hide resolved
src/SFML.Graphics/VertexArray.cs Outdated Show resolved Hide resolved
src/SFML.Graphics/VertexBuffer.cs Outdated Show resolved Hide resolved
@DemoXinMC
Copy link
Contributor Author

I've updated the PR with some more changes.

  • Adjusted changes to align with eXpl0it3r's feedback.
  • Added a compile-time #warning to VertexBuffer.NativeHandle's getter warning the user to be cautious with NativeHandle and that most people won't need to use it.
  • Made use of <paramref /> in many places. Lots more of this to do.

@Marioalexsan Marioalexsan mentioned this pull request Feb 16, 2024
Merged
@DemoXinMC
In-code Documentation Update
c12f3c7 
* Addresses requests in SFML#194 and SFML#195
* Updated all [Obsolete] attributes to be less repetitive
* Added a large number of quick reference links to existing summaries
* Corrected various typos and unparsable markup(\a and \p)
* Added additional formatting to numerous summaries, resulting in more readable tooltips
* Added a suggestion to use TimeSpan over SFML's Time while working within a managed environment
@eXpl0it3r eXpl0it3r merged commit cb9c755 into SFML:master Feb 17, 2024
15 checks passed
@eXpl0it3r
Copy link
Member

Thank you for these updates! 🙂

@DemoXinMC DemoXinMC deleted the Docs-Update branch February 21, 2024 22:49
@eXpl0it3r eXpl0it3r mentioned this pull request May 23, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eXpl0it3r eXpl0it3r eXpl0it3r approved these changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@DemoXinMC @eXpl0it3r