/** * Process the see tags. * * @param int $commentStart The position in the stack where the comment started. * * @return void */ protected function processSees($commentStart) { $sees = $this->commentParser->getSees(); if (empty($sees) === false) { $tagOrder = $this->commentParser->getTagOrders(); $index = array_keys($this->commentParser->getTagOrders(), 'see'); foreach ($sees as $i => $see) { $errorPos = $commentStart + $see->getLine(); $since = array_keys($tagOrder, 'since'); if (count($since) === 1 && $this->_tagIndex !== 0) { $this->_tagIndex++; if ($index[$i] !== $this->_tagIndex) { $error = 'The @see tag is in the wrong order; the tag precedes @return'; $this->currentFile->addError($error, $errorPos, 'SeeOrder'); } } $content = $see->getContent(); if (empty($content) === true) { $error = 'Content missing for @see tag in function comment'; $this->currentFile->addError($error, $errorPos, 'EmptySee'); continue; } $spacing = substr_count($see->getWhitespaceBeforeContent(), ' '); if ($spacing !== 4) { $error = '@see tag indented incorrectly; expected 4 spaces but found %s'; $data = array($spacing); $this->currentFile->addError($error, $errorPos, 'SeeIndent', $data); } } //end foreach } //end if }
/** * Process the see tags * * @param integer $commentStart The position in the stack where the comment started * @return void */ protected function _processSees($commentStart) { $sees = $this->_commentParser->getSees(); if (empty($sees) === false) { $tagOrder = $this->_commentParser->getTagOrders(); $index = array_keys($this->_commentParser->getTagOrders(), 'see'); foreach ($sees as $i => $see) { $errorPos = $commentStart + $see->getLine(); $since = array_keys($tagOrder, 'since'); if (count($since) === 1 and $this->_tagIndex !== 0) { $this->_tagIndex++; if ($index[$i] !== $this->_tagIndex) { $error = 'The @see tag is in the wrong order; the tag follows @since (if used) or @param'; $this->_currentFile->addError($error, $errorPos); } } $content = $see->getContent(); if (empty($content) === true) { $error = 'Content missing for @see tag in function comment'; $this->_currentFile->addError($error, $errorPos); continue; } $spacing = substr_count($see->getWhitespaceBeforeContent(), ' '); if ($spacing !== 4) { $error = '@see tag indented incorrectly; '; $error .= "expected 4 spaces but found {$spacing}"; $this->_currentFile->addError($error, $errorPos); } } } }
/** * Process the see tags. * * @param int $commentStart The position in the stack where the comment started. * * @return void */ private function _processSees($commentStart) { $sees = $this->commentParser->getSees(); if (empty($sees) === false) { $tagOrder = $this->commentParser->getTagOrders(); $index = array_keys($this->commentParser->getTagOrders(), 'see'); foreach ($sees as $i => $see) { $errorPos = $commentStart + $see->getLine(); $since = array_keys($tagOrder, 'since'); if (count($since) === 1 && $this->_tagIndex !== 0) { $this->_tagIndex++; if ($index[$i] !== $this->_tagIndex) { $error = 'The order of @see tag is wrong in function comment'; $this->currentFile->addError($error, $errorPos); } } $content = $see->getContent(); if (empty($content) === true) { $error = 'Content missing for @see tag in function comment'; $this->currentFile->addError($error, $errorPos); continue; } $spacing = substr_count($see->getWhitespaceBeforeContent(), ' '); if ($spacing !== 4) { $error = '@see tag indented incorrectly. '; $error .= "Expected 4 spaces but found {$spacing}."; $this->currentFile->addError($error, $errorPos); } } //end foreach } //end if }