Generate rustdoc documentation for all publicly exported items #647
Conversation
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
Signed-off-by: Simon Wülker <[email protected]>
nicoburns
reviewed
Jul 25, 2025
|
Possible, either way, they're not needed anymore (tests run fine without them) |
mrobinson
approved these changes
Jul 25, 2025
| pub use self::AttrValueKind::*; | ||
| pub use self::DoctypeKind::*; | ||
| pub use self::XmlState::*; | ||
| #![allow(missing_docs)] // FIXME |
There was a problem hiding this comment.
Please open a bug for this and link to it here. Thanks!
There was a problem hiding this comment.
Done: #648. Thanks for the review (:
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
A few of the items in xml5ever are annotated with
#[doc(hidden)]. This causes theinitial_statefield in https://docs.rs/xml5ever/latest/xml5ever/tokenizer/struct.XmlTokenizerOpts.html to not link to the enum, which is bad.Presumably this is done because the author wanted to get around the
#[deny(missing_docs)]lint? I'm not sure. Not all of these need to be public and I have reduced the visibility of a few items (NamespaceMapand a few methods) topub(crate). This makes this PR a breaking change. I believe that these were not intended to be public in the first place, but I can undo that if requested.