Skip to content
This repository has been archived by the owner on Jan 10, 2023. It is now read-only.

Implement use triple slash for documentation comments #71

Conversation

atamez31
Copy link

No description provided.

@atamez31 atamez31 force-pushed the implement-UseTripleSlashForDocumentationComments branch from e56b93f to 1b1ad84 Compare June 26, 2018 21:47
return isInvalid ? token.withLeadingTrivia(Trivia.init(pieces: pieces)) : token
}

/// Indicates if a doc block comment is between tokens on the same line.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is duplicated from NoBlockComments, it might be best to move this into a convenience method inside TokenSyntax+Convenience.swift

}

/// Converts the text of doc block comment into a format for a doc line comment.
func convertsDocBlockCommentToDocLineComment(_ text: String) -> String {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Functions should be verbs, so convertDocBlockCommentToDocLineComment.

@harlanhaskins
Copy link

Looks great!

@allevato
Copy link
Member

Can you address Harlan's feedback here, and then I'll take a closer look?

Copy link
Member

@allevato allevato left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!

@allevato allevato merged commit 8c3f4db into google:format Jul 26, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants