fix: ship the XML documentation, so the remarks reach a consumer - #8
Merged
Conversation
The note added in #7 saying AssetAccessorCallbacksSet does not work on browser-wasm was generated, packed and invisible: the package contains lib/net10.0/*.dll and nothing else, so no IntelliSense in a consuming project ever shows it. Checked on the built artifact rather than assumed. That makes the note worth exactly nothing to the person it was written for, which was the whole point of writing it before publishing. CS1591 is suppressed rather than answered. It asks for a comment on every public member and 604 of them are generated from C headers that carry no documentation to copy, so silencing it keeps the comments that do exist useful instead of burying the build in warnings about the ones that cannot exist. Verified locally: regenerating with the current generator produces the remark twice, once per callbacks struct, and both survive into the .xml the package now carries.
Contributor
API gate: additiveEvery symbol that existed still exists, unchanged. Nothing that compiled before stops compiling.
Enum and constant values are part of the measured surface: a renumbering keeps compiling and sends the wrong number to the driver, so it counts as a removal. |
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
1 participant
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.
The note added in #7 — that
AssetAccessorCallbacksSetdoes not work on browser-wasm — wasgenerated, packed, and invisible. The package contains
lib/net10.0/*.dlland nothing else, soIntelliSense in a consuming project never shows it.
Checked on the built artifact rather than assumed:
Which made that note worth nothing to the person it was written for, and writing it before
publishing was the whole point.
CS1591is suppressed rather than answered. It asks for a comment on every public member, and604 of them are generated from C headers that carry no documentation to copy, so silencing it
keeps the comments that do exist useful instead of burying the build in warnings about the ones
that cannot exist.
Verified locally: regenerating with the current generator puts the remark in the
.xmltwice,once per callbacks struct.