Differentiate documentation from triple slashes and doc attribute #3209
Conversation
This file contains 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
MajoraSans
changed the title
MajoraSans
force-pushed
the
diff-between-slash-and-attr
branch
3 times, most recently
from
ef596d9
to
cad477c
Compare
gcc/rust/ChangeLog: * ast/rust-ast-collector.cc (TokenCollector::visit): Add behaviour. In Attribute visitor, recognize doc from comment and handle it. * ast/rust-ast.h: Changes Attribute constructor and add a boolean in the class for doc comments. * lex/rust-token.cc (Token::as_string): Return the correct string for the new DOC_STRING_LITERAL token. * lex/rust-token.h (enum PrimitiveCoreType): Add two tokens : DOC_STRING_LITERAL and DOC_END, for pretty-printing purposes. Also modify the string of two previous tokens. * parse/rust-parse-impl.h (Parser::parse_inner_attribute): Updates the Attribute constructor call. (Parser::parse_outer_attribute): Same as above. Signed-off-by: lucas.plantrose <[email protected]>
MajoraSans
force-pushed
the
diff-between-slash-and-attr
branch
from
cad477c
to
91d4c03
Compare
CohenArthur
reviewed
Oct 30, 2024
| @@ -636,6 +636,9 @@ struct Attribute | |||
|
|
|||
| bool inner_attribute; | |||
|
|
|||
| // Only relevant in case of a doc attribute | |||
| bool from_comment; | |||
There was a problem hiding this comment.
Suggested change
| bool from_comment; | |
| bool from_doc_comment; |
Comment on lines
+650
to
+651
| location_t locus = UNDEF_LOCATION, bool inner_attribute = false, | ||
| bool from_comment = false) |
There was a problem hiding this comment.
I'm not a big fan of the two booleans here. I think it would be nice to improve it with two enums
Comment on lines
+147
to
+148
| RS_TOKEN (INNER_DOC_COMMENT, "/**!") \ | ||
| RS_TOKEN (OUTER_DOC_COMMENT, "/**") \ |
There was a problem hiding this comment.
Suggested change
| RS_TOKEN (INNER_DOC_COMMENT, "/**!") \ | |
| RS_TOKEN (OUTER_DOC_COMMENT, "/**") \ | |
| RS_TOKEN (INNER_DOC_COMMENT, "//!") \ | |
| RS_TOKEN (OUTER_DOC_COMMENT, "///") \ |
| RS_TOKEN (OUTER_DOC_COMMENT, "#[doc]") \ | ||
| RS_TOKEN (INNER_DOC_COMMENT, "/**!") \ | ||
| RS_TOKEN (OUTER_DOC_COMMENT, "/**") \ | ||
| RS_TOKEN (DOC_COMMENT_END, "*/") \ |
| RS_TOKEN (INNER_DOC_COMMENT, "/**!") \ | ||
| RS_TOKEN (OUTER_DOC_COMMENT, "/**") \ | ||
| RS_TOKEN (DOC_COMMENT_END, "*/") \ | ||
| RS_TOKEN (DOC_STRING_LITERAL, "string") \ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #3196
This PR changes some files in the ast directory as well as in the lex directory. It introduces two new tokens only used in pretty-printing, and changes the visitor of the Attribute class in the TokenCollector to properly detect doc attributes coming from comments. Also, a new boolean in the Attribute class has appeared to keep track of the origin of the attribute, and is only relevant in the case of a 'doc' attribute.