Closed (won't fix)
Project:
Drupal Code Sniffer
Version:
7.x-1.x-dev
Component:
Code
Priority:
Normal
Category:
Bug report
Assigned:
Unassigned
Reporter:
Created:
10 Dec 2011 at 04:56 UTC
Updated:
4 Jan 2013 at 12:36 UTC
Doc comment for var $settings does not match actual variable name &$settings at position 1
@param statements shouldn't contain the & for parameters passed by reference.
Comments
Comment #1
das-peter commentedThanks for reporting this. :)
Fixed and committed: http://drupalcode.org/project/drupalcs.git/commit/f6555d5
Comment #2
klausiAre we sure about that? I think it is a huge advantage if I see in the documentation that the parameter is taken as reference. Do we have any rule regarding this in the coding standards?
Comment #3
das-peter commentedKlausi you're right - at least I couldn't find such a rule.
We should try to get such a rule into the standards and then adjust the sniff accordingly.
According to the documentation we should:
Shall we open such an issue or does anyone know who we could contact first?
Comment #4
tim.plunkettYou can ask jhodgdon, but she will likely tell you to file an issue.
This is definitely fixed for now, I won't change the status but it should be fixed or postponed.
Comment #5
klausiI have disabled the warning if the "&" is in the @param documentation until this is sorted out. See http://drupalcode.org/project/drupalcs.git/commit/1a6268a
I would say this issue stays "active" until we have a drupal core issue to settle the coding standards for this.
Comment #6
klausiOpened a core issue: #1368794: Using '&' in doxygen @param documentation. This issue is postponed until we reach a solution there.
Comment #7
klausiDrupal Code Sniffer has been merged into Coder 7.x-2.x. Please move this issue to the Coder queue and reopen it if the problem still exists.