Add a property for skipping processing on {@inheritdoc}.

Author: xjm

src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php

@@ -17,6 +17,13 @@
 class FunctionCommentSniff extends PEARFunctionCommentSniff
 {
 
+    /**
+     * Whether to skip inheritdoc comments.
+     *
+     * @var bool
+     */
+    public $skipIfInheritdoc = false;
+
     /**
      * The current PHP version.
      *
@@ -40,6 +47,14 @@ protected function processReturn(File $phpcsFile, $stackPtr, $commentStart)
         $tokens = $phpcsFile->getTokens();
         $return = null;
 
+        if ($this->skipIfInheritdoc) {
+            for ($i = $commentStart; $i <= $tokens[$commentStart]['comment_closer']; $i++) {
+                $trimmedContent = strtolower(trim($tokens[$i]['content']));
+                if ($trimmedContent === '{@inheritdoc}') {
+                    return;
+                }
+            }
+        }
         foreach ($tokens[$commentStart]['comment_tags'] as $tag) {
             if ($tokens[$tag]['content'] === '@return') {
                 if ($return !== null) {
@@ -189,6 +204,15 @@ protected function processThrows(File $phpcsFile, $stackPtr, $commentStart)
     {
         $tokens = $phpcsFile->getTokens();
 
+        if ($this->skipIfInheritdoc) {
+            for ($i = $commentStart; $i <= $tokens[$commentStart]['comment_closer']; $i++) {
+                $trimmedContent = strtolower(trim($tokens[$i]['content']));
+                if ($trimmedContent === '{@inheritdoc}') {
+                    return;
+                }
+            }
+        }
+
         foreach ($tokens[$commentStart]['comment_tags'] as $pos => $tag) {
             if ($tokens[$tag]['content'] !== '@throws') {
                 continue;
@@ -264,6 +288,15 @@ protected function processParams(File $phpcsFile, $stackPtr, $commentStart)
 
         $tokens = $phpcsFile->getTokens();
 
+        if ($this->skipIfInheritdoc) {
+            for ($i = $commentStart; $i <= $tokens[$commentStart]['comment_closer']; $i++) {
+                $trimmedContent = strtolower(trim($tokens[$i]['content']));
+                if ($trimmedContent === '{@inheritdoc}') {
+                    return;
+                }
+            }
+        }
+
         $params  = [];
         $maxType = 0;
         $maxVar  = 0;