Skip to content

Change some phpdocs to simple comments #4945

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

Jump to bottom
Merged
merged 1 commit into from
Jul 18, 2021
Merged

Change some phpdocs to simple comments #4945

merged 1 commit into from
Jul 18, 2021

Conversation

paulbalandan
Copy link
Member

Description

  • Docblocks should only be used on structural elements. (Enabled only on a few files then disabled. Current behavior is not desired)
  • Remaining rules are turned off as these breaks signatures. These can be used on migration rules instead.

Checklist:

  • Securely signed commits

MGatner
MGatner approved these changes Jul 18, 2021
View reviewed changes
Copy link
Member

@MGatner MGatner left a comment

Choose a reason for hiding this comment

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

So basically, /** indicates a "docblock" so should only be used thus - block comments can use the single asterisk?

@paulbalandan
Copy link
Member Author

So basically, /** indicates a "docblock" so should only be used thus - block comments can use the single asterisk?

Yes. /** is the marker for T_DOC_COMMENT. /* */ is for multi-line comments

@paulbalandan paulbalandan merged commit 36152b3 into codeigniter4:develop Jul 18, 2021
@paulbalandan paulbalandan deleted the others branch July 18, 2021 14:13
element-code pushed a commit to element-code/CodeIgniter4 that referenced this pull request Aug 2, 2021
@paulbalandan @element-code
Change some phpdocs to simple comments (codeigniter4#4945)
56c711a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MGatner MGatner MGatner approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@paulbalandan @MGatner