Skip to content

clarify docCommentValue's docComment #3241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PhantomInTheWire wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −1
Open

clarify docCommentValue's docComment #3241

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion Sources/SwiftSyntax/Trivia+commentValue.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,13 @@
//===----------------------------------------------------------------------===//

extension Trivia {
/// The contents of the last doc comment piece with any comment markers removed and indentation whitespace stripped.
/// The normalized contents of the documentation comment in this trivia.
///
/// Returns the content of the last documentation comment block, which semantically represents
/// "the one and only" documentation comment associated with this trivia. Comment markers are
/// removed, common indentation is stripped, and line endings are normalized to `\n`.
///
/// Returns `nil` if no documentation comment is present.
public var docCommentValue: String? {
var comments: [Substring] = []
var currentLineComments: [String] = [] // Reset line comments when encountering a block comment
Expand Down