fix(DocCommentAlignment): Allow @see references to be indented under @param docs (#3073750)

Author: klausi

coder_sniffer/Drupal/Sniffs/Commenting/DocCommentAlignmentSniff.php

@@ -137,9 +137,10 @@ public function process(File $phpcsFile, $stackPtr)
  }
  } else if ($tokens[($i + 2)]['code'] === T_DOC_COMMENT_TAG
  && $tokens[($i + 1)]['content'] !== ' '
- // Special @code/@endcode tags can have more than 1 space.
+ // Special @code/@endcode/@see tags can have more than 1 space.
  && $tokens[($i + 2)]['content'] !== '@code'
  && $tokens[($i + 2)]['content'] !== '@endcode'
+ && $tokens[($i + 2)]['content'] !== '@see'
  ) {
  $error = 'Expected 1 space after asterisk; %s found';
  $data = [strlen($tokens[($i + 1)]['content'])];

coder_sniffer/Drupal/Sniffs/Commenting/DocCommentSniff.php

@@ -378,6 +378,7 @@ public function process(File $phpcsFile, $stackPtr)
  $ignoreTags = [
  '@code',
  '@endcode',
+ '@see',
  ];
  foreach ($tokens[$commentStart]['comment_tags'] as $pos => $tag) {
  if ($pos > 0) {

coder_sniffer/Drupal/Test/Commenting/DocCommentAlignmentUnitTest.inc

@@ -16,3 +16,14 @@ class Test {
  var $varStyle;
 
 }
+
+/**
+ * Short description.
+ *
+ * @param string $a
+ * The following reference is allowed to be indented.
+ * @see my_function()
+ */
+function test31($a) {
+
+}

coder_sniffer/Drupal/Test/Commenting/DocCommentAlignmentUnitTest.inc.fixed

@@ -16,3 +16,14 @@ class Test {
  public $varStyle;
 
 }
+
+/**
+ * Short description.
+ *
+ * @param string $a
+ * The following reference is allowed to be indented.
+ * @see my_function()
+ */
+function test31($a) {
+
+}