rust: account for doc comment syntax#397
Open
tomjakubowski wants to merge 1 commit into
Open
Conversation
Rust has two flavors of comment, the plain line comment (`//`) and the doc comment (`///`). Rustdoc, the native documentation tool, renders only doc comments (`///`). docco now searches for both `//` comments and `///` comments in Rust source files. Previously, it had only searched for `//` comments, so `///` comments were rendered with an ugly superfluous `/` at the start of their content.
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.
Rust has two flavors of comment, the plain line comment (
//) and the doccomment (
///). Rustdoc, the native documentation tool, renders only doccomments (
///).docco now searches for both
//comments and///comments in Rust sourcefiles. Previously, it had only searched for
//comments, so///commentswere rendered with an ugly superfluous
/at the start of their content.