Add XML comments to all public members#561
Merged
Conversation
codebude
requested changes
Jun 2, 2024
Collaborator
codebude
left a comment
codebude
left a comment
There was a problem hiding this comment.
Wow, that looks like a lot of work. Thanks! Before merging I kindly ask you to fix the test cases, too.
16 tasks
codebude
approved these changes
Jun 3, 2024
Shane32
added
the
documentation
vaernion
pushed a commit
to Arbeidstilsynet/brevgen2
that referenced
this pull request
Dec 3, 2025
This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [QRCoder](https://github.com/codebude/QRCoder) | `1.4.3` -> `1.6.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>codebude/QRCoder (QRCoder)</summary> ### [`v1.6.0`](https://github.com/codebude/QRCoder/releases/tag/v1.6.0) #### What has changed - \[Enhancement] Huge performance (runtime and memory) optimization in `QrCodeGenerator` (PRs [#​509](Shane32/QRCoder#509), [#​519](Shane32/QRCoder#519), [#​520](Shane32/QRCoder#520), [#​521](Shane32/QRCoder#521), [#​524](Shane32/QRCoder#524), [#​530](Shane32/QRCoder#530), [#​532](Shane32/QRCoder#532)) - \[Enhancement] Big performance (runtime and memory) optimization in `BitmapByteQRCode` (PR [#​566](Shane32/QRCoder#566)) - \[Enhancement] Added ECC level mismatch detection when using payloads from payload generator (PR [#​526](Shane32/QRCoder#526)) - \[Enhancement] Implementation of encoding constraints (EccLevel, EciMode) in SwissQRCode and GiroCode payloads to enforce that the payloads comply with the specifications of the respective standards (PR [#​533](Shane32/QRCoder#533)) - \[Enhancement] Added support for trimming (`IsTrimmable` project property) (PR [#​539](Shane32/QRCoder#539)) - \[Enhancement] Added XML comments (code documentation) to all public members (PR [#​561](Shane32/QRCoder#561)) - \[Enhancement] Added new/third overload to `PngByteQRCode` that accepts colors as System.Drawing.Color (PR [#​564](Shane32/QRCoder#564)) - \[Enhancement] Updated the Bitmap header from BITMAPCOREHEADER to BITMAPINFOHEADER in `BitmapByteQRCode` (PR [#​565](Shane32/QRCoder#565)) - \[Refactoring] Restructured `QRCodeGenerator` classes into separate files and partially restructured code for better manageability (PRs [#​516](Shane32/QRCoder#516), [#​528](Shane32/QRCoder#528), [#​531](https://github....
This was referenced Dec 5, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds XML comments to all public members
No code has been changed.
Test Plan
CS1591 is enforced so any public members added in the future will require XML comments or will break the build.
Notes
These xml comments may not be perfect, but they're better than nothing. Please suggest any changes desired.