Merge pull request #10 from chadicus/develop

Update coding standard to only require phpdoc for public methods

Author: chadicus

Chadicus/Sniffs/Commenting/FunctionCommentSniff.php

@@ -0,0 +1,22 @@
+<?php
+
+final class Chadicus_Sniffs_Commenting_FunctionCommentSniff extends Squiz_Sniffs_Commenting_FunctionCommentSniff
+{
+    /**
+     * Ensures only public methods are processed.
+     *
+     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+     * @param int                  $stackPtr  The position of the current token in the stack passed in $tokens.
+     *
+     * @return void
+     */
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    {
+        $methodProperties = $phpcsFile->getMethodProperties($stackPtr);
+        if ($methodProperties['scope'] !== 'public') {
+            return;
+        }
+
+    	parent::process($phpcsFile, $stackPtr);
+    }
+}

Chadicus/ruleset.xml

@@ -10,7 +10,6 @@
     <rule ref="Generic.CodeAnalysis.UselessOverridingMethod" />
     <rule ref="Generic.ControlStructures.InlineControlStructure" />
     <rule ref="Squiz.Commenting.DocCommentAlignment" />
-    <rule ref="Squiz.Commenting.FunctionComment" />
     <rule ref="Squiz.Commenting.FunctionCommentThrowTag" />
     <rule ref="Squiz.Commenting.VariableComment" />
     <rule ref="Generic.Commenting.Fixme" />