Respect /** This action is documented in some-class.php */ comment.

Author: kagg-design

WPForms/Sniffs/Comments/ParamTagHooksSniff.php

@@ -70,7 +70,6 @@ public function process( File $phpcsFile, $stackPtr ) {
 			return;
 		}
 
-		$tokens       = $phpcsFile->getTokens();
 		$commentEnd   = $phpcsFile->findPrevious( T_DOC_COMMENT_CLOSE_TAG, $stackPtr );
 		$commentStart = $phpcsFile->findPrevious( T_DOC_COMMENT_OPEN_TAG, $commentEnd );
 

WPForms/Tests/TestFiles/Comments/ParamTagHooks.php

@@ -178,7 +178,7 @@ function () {
 
 // The next case generated the endless loop in the \WPForms\Sniffs\Comments\ParamTagHooksSniff::countArguments.
 
-/** This action is documented in some-class.php. */
+/** This action is documented in some-class.php */
 do_action( 'wpforms_display_submit_after', $this->displaysubmit_after_action );
 
 // This case generated 'You should have 39 @param tags' (39 as an example).
@@ -195,3 +195,11 @@ function () {
 	'http://site.org/cool-page',
 	[]
 );
+
+// These actions/filters should not produce an error.
+
+/** This action is documented in includes/class-frontend.php */
+do_action( 'wpforms_display_submit_after', $this->form_data );
+
+/** This filter is documented in wp-includes/post-template.php */
+$content = apply_filters( 'the_content', $content );

WPForms/Tests/Tests/Comments/ParamTagHooksTest.php

@@ -22,7 +22,7 @@ public function testProcess() {
 		$phpcsFile = $this->process( new ParamTagHooksSniff() );
 
 		$this->fileHasErrors( $phpcsFile, 'InvalidAlign', [ 49, 50, 51, 52, 53 ] );
-		$this->fileHasErrors( $phpcsFile, 'InvalidParamTagsQuantity', [ 75, 182 ] );
+		$this->fileHasErrors( $phpcsFile, 'InvalidParamTagsQuantity', [ 75 ] );
 		$this->fileHasErrors( $phpcsFile, 'MissParamInfo', [ 103, 104, 105, 106, 107, 108, 109 ] );
 		$this->fileHasErrors( $phpcsFile, 'AddStopSymbol', [ 133, 134, 138 ] );
 		$this->fileHasErrors( $phpcsFile, 'ExtraSpacesAfterParamTag', [ 160, 161, 162, 163, 164 ] );

WPForms/Traits/DuplicateHook.php

@@ -23,20 +23,31 @@ trait DuplicateHook {
 	 */
 	protected function isDuplicateHook( $commentStart, $tokens ) {
 
+		$commentEnd = isset( $tokens[ $commentStart ]['comment_closer'] ) ? $tokens[ $commentStart ]['comment_closer'] : false;
+
 		$see = $this->findTag( '@see', $commentStart, $tokens );
 
-		if ( ! $see ) {
-			return false;
-		}
+		$seeTagFound = $see && $commentEnd && ( $see['tag'] < $commentEnd );
 
-		if ( $tokens[ $see['tag'] + 2 ]['code'] !== T_DOC_COMMENT_STRING ) {
-			return false;
+		if ( $seeTagFound ) {
+			$commentStringPtr = $see['tag'] + 2;
+		} else {
+			$commentStringPtr = $commentStart + 2;
+
+			if ( $tokens[ $commentStart ]['line'] !== $tokens[ $commentEnd ]['line'] ) {
+				return false;
+			}
 		}
 
-		if ( 0 === strpos( $tokens[ $see['tag'] + 2 ]['content'], 'This filter is documented in ' ) ) {
-			return true;
+		$content = $tokens[ $commentStringPtr ]['content'];
+
+		if ( $tokens[ $commentStringPtr ]['code'] !== T_DOC_COMMENT_STRING ) {
+			return false;
 		}
 
-		return 0 === strpos( $tokens[ $see['tag'] + 2 ]['content'], 'This action is documented in ' );
+		return (
+			0 === strpos( $content, 'This action is documented in ' ) ||
+			0 === strpos( $content, 'This filter is documented in ' )
+		);
 	}
 }