Page MenuHomePhabricator
Create Task
Maniphest T238470

Add a sniff to check for doc comment formatting
Closed, ResolvedPublic
Actions

Description

The current FunctionCommentSniff has code to check if a doc comment is well formatted.

That includes

  • Using exact /** or * syntax
  • one * per line
  • * alligned in the same column
  • Checking for whitespace after *
  • Closing */ on the same indent as the opening /**
  • Multi line comment having */ on own line

All this formatting could also apply to class comments or file comments and should be moved to own sniff

Details

SubjectRepoBranchLines +/-
Improve sniff for doc commentsmediawiki/tools/codesniffermaster+163 -21
Create new sniff for doc commentsmediawiki/tools/codesniffermaster+562 -473
Customize query in gerrit

Event Timeline

Umherirrender created this task.Nov 16 2019, 12:57 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptNov 16 2019, 12:57 PM
gerritbot added a comment.Nov 16 2019, 12:58 PM

Change 528280 had a related patch set uploaded (by Umherirrender; owner: Umherirrender):
[mediawiki/tools/codesniffer@master] Create new sniff for doc comments

https://gerrit.wikimedia.org/r/528280

gerritbot added a project: Patch-For-Review.Nov 16 2019, 12:58 PM
gerritbot added a comment.Nov 17 2019, 7:01 PM

Change 528280 merged by jenkins-bot:
[mediawiki/tools/codesniffer@master] Create new sniff for doc comments

https://gerrit.wikimedia.org/r/528280

Maintenance_bot removed a project: Patch-For-Review.Nov 17 2019, 7:10 PM
gerritbot added a comment.Nov 18 2019, 3:34 PM

Change 551557 had a related patch set uploaded (by Umherirrender; owner: Umherirrender):
[mediawiki/tools/codesniffer@master] Improve sniff for doc comments

https://gerrit.wikimedia.org/r/551557

gerritbot added a project: Patch-For-Review.Nov 18 2019, 3:34 PM
gerritbot added a comment.Nov 22 2019, 7:52 PM

Change 551557 merged by jenkins-bot:
[mediawiki/tools/codesniffer@master] Improve sniff for doc comments

https://gerrit.wikimedia.org/r/551557

Maintenance_bot removed a project: Patch-For-Review.Nov 22 2019, 8:10 PM
Umherirrender closed this task as Resolved.Nov 22 2019, 11:26 PM
Umherirrender triaged this task as Medium priority.
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL