Skip to content
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.

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

Added support for multiline documentation comments #1293

Merged
merged 2 commits into from
Mar 6, 2024

Conversation

art-divin
Copy link
Collaborator

@art-divin art-divin commented Mar 5, 2024

Resolves #1056

Context

This PR enables Sourcery to understand multiline documentation comments, like:

/** 
 Documentation comment
*/
func something() {}

/** Documentation comment */
func something() {}

/** Documentation comment
*/
func something() {}

/** 
 Documentation comment */
func something() {}

, while keeping comments of type /* comment */ as simple comment and not documentationComment to preserve functionality of documentation parser as it was before his PR.

@art-divin art-divin added this to the 2.1.8 milestone Mar 5, 2024
@art-divin art-divin self-assigned this Mar 5, 2024
@art-divin art-divin merged commit ce36d2c into master Mar 6, 2024
2 checks passed
@art-divin art-divin deleted the parse-multiline-doc-comments branch March 6, 2024 08:57
art-divin added a commit that referenced this pull request Mar 17, 2024
* Added support for multiline documentation comments

* Checking `documentationComment` type for annotations
art-divin added a commit that referenced this pull request Mar 17, 2024
* Added support for multiline documentation comments

* Checking `documentationComment` type for annotations
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Multiline doc comments not working properly
1 participant