bestit / PHP_CodeSniffer

     *

     * @return int|bool Pointer to the end of the description or false

     */

    private function getCommentDescriptionEndPointer()

    {

        $descriptionStartPtr = $this->getCommentDescriptionStartPointer();

        $commentStartToken = $this->docHelper->getCommentStartToken();

        $commentEndPtr = $this->docHelper->getCommentEndPointer();

        //If no tags found, possible end of search is the starting tag of the doc comment.

        if (count($commentStartToken['comment_tags']) === 0) {

            return $this->file->findPrevious(

                T_DOC_COMMENT_STRING,

                $commentEndPtr - 1,

                $descriptionStartPtr

            );

        }

        //else its the pointer of the first comment tag found.

        $firstTagPtr = array_shift($commentStartToken['comment_tags']);

        return $this->file->findPrevious(

            T_DOC_COMMENT_STRING,

            $firstTagPtr - 1,

            $descriptionStartPtr

        );

    }

    /**

     * Returns pointer to the start of the long description or false if not found.

     *

     * @return bool|int Pointer to the start of the description or false

     */

    private function getCommentDescriptionStartPointer()

    {

        $commentStartToken = $this->docHelper->getCommentStartToken();

        $commentEndPtr = $this->docHelper->getCommentEndPointer();

        $summaryPtr = $this->summaryHelper->getCommentSummaryPointer();

        //If no tags the possible end of search is the closing tag of the doc comment.

        if (count($commentStartToken['comment_tags']) === 0) {

            return $this->file->findNext(

                T_DOC_COMMENT_STRING,

                $summaryPtr + 1,

                $commentEndPtr

            );

        }

        //else its the pointer of the first comment tag found.

        $firstTagPtr = array_shift($commentStartToken['comment_tags']);

        return $this->file->findNext(

            T_DOC_COMMENT_STRING,

            $summaryPtr + 1,

            $firstTagPtr - 1

        );

    }

    /**

     * Adds error when description is not found.