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.

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

[CS] fix some doc comment types #20522

Merged
merged 2 commits into from
May 24, 2018
Merged

[CS] fix some doc comment types #20522

merged 2 commits into from
May 24, 2018

Commits on May 21, 2018

  1. PHPCS2 manual fixes 

    - Variables passed by reference should not have the `&` prefixed in the doc comment
  - Joomla.Commenting.FunctionComment.MissingParamTag
  - Joomla.Commenting.FunctionComment.ParamNameNoMatch
- correct return statement
    @photodude
    photodude committed May 21, 2018
    Configuration menu
    Copy the full SHA
    d130e4f View commit details
    Browse the repository at this point in the history

  2. exclude administrator/components/ folder 

    "Having a "&" in the docblock (whether it's in front of the type or name) is not valid. References are to be expressed solely by the function/method declaration."

so we need to exclude this sniff while we trasition to the PHPCS 2.x version
    @photodude
    photodude committed May 21, 2018
    Configuration menu
    Copy the full SHA
    a722930 View commit details
    Browse the repository at this point in the history