Closed (fixed)
Project:
Coder
Version:
7.x-2.x-dev
Component:
Code Sniffer
Priority:
Normal
Category:
Feature request
Assigned:
Unassigned
Reporter:
Created:
22 Oct 2012 at 18:55 UTC
Updated:
14 Dec 2012 at 20:10 UTC
This is a follow-up as the result of a patch review in #1818016-7: Make Breakpoint module pass Coder Review point 3). That addressed the following code in core's Breakpoint module:
/**
* Implements hook_modules_enabled().
*
* @param array $modules
* An array of the modules that were enabled.
*
* @see _breakpoint_modules_enabled()
*
* @todo: This should be removed if https://drupal.org/node/1813100 is resolved.
*/
As stated in that review,
The Coder report does not point out the inconsistent use of @param and @return directives in breakpoint_themes_enabled() and breakpoint_themes_disabled(). The are both hook implementations. I believe that either the @param directives should be removed or @return directives should be added. At present, the documentation does not conform with #1354: [Obsolete] API documentation and comment standards.
The purpose of this issue is create a sniff that will identify this type of inconsistency in the future.
Comments
Comment #1
klausiFixed: http://drupalcode.org/project/coder.git/commit/b982afd
Comment #2
lars toomre commentedThanks @klausi! Looks good to me.