Merge pull request #961 from PHPCSStandards/feature/various-minor-docs-fixes

Docs: various minor fixes

Author: jrfnl

CHANGELOG.md

@@ -2268,7 +2268,7 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
     - Thanks to [Juliette Reinders Folmer][@jrfnl] for the help with this patch
 - Array properties set inside a ruleset.xml file can now extend a previous value instead of always overwriting it
     - e.g., if you include a ruleset that defines forbidden functions, can you now add to that list instead of having to redefine it
-    - To use this feature, add extends="true" to the property tag
+    - To use this feature, add extend="true" to the property tag
         - e.g., property name="forbiddenFunctionNames" type="array" extend="true"
     - Thanks to [Michael Moravec][@Majkl578] for the patch
 - If $XDG_CACHE_HOME is set and points to a valid directory, it will be used for caching instead of the system temp directory

src/Sniffs/AbstractScopeSniff.php

@@ -14,7 +14,7 @@
  *     protected function processTokenWithinScope(\PHP_CodeSniffer\Files\File $phpcsFile, $stackPtr, $currScope)
  *     {
  *         $className = $phpcsFile->getDeclarationName($currScope);
- *         echo 'encountered a method within class '.$className;
+ *         $phpcsFile->addWarning('encountered a method within class '.$className, $stackPtr, 'MethodFound');
  *     }
  * }
  * </code>

src/Tokenizers/Comment.php

@@ -16,14 +16,11 @@ class Comment
 
 
     /**
-     * Creates an array of tokens when given some PHP code.
+     * Splits a single doc block comment token up into something that can be easily iterated over.
      *
-     * Starts by using token_get_all() but does a lot of extra processing
-     * to insert information about the context of the token.
-     *
-     * @param string $string   The string to tokenize.
+     * @param string $string   The doc block comment string to parse.
      * @param string $eolChar  The EOL character to use for splitting strings.
-     * @param int    $stackPtr The position of the first token in the file.
+     * @param int    $stackPtr The position of the token in the "new"/final token stream.
      *
      * @return array<int, array<string, string|int|array<int>>>
      */

src/Tokenizers/PHP.php

@@ -2298,7 +2298,7 @@ function return types. We want to keep the parenthesis map clean,
                         ) {
                             // Non-empty content.
                             if (is_array($tokens[$x]) === true && $tokens[$x][0] === T_USE) {
-                                // Found a use statements, so search ahead for the closing parenthesis.
+                                // Found a use statement, so search ahead for the closing parenthesis.
                                 for ($x += 1; $x < $numTokens; $x++) {
                                     if (is_array($tokens[$x]) === false && $tokens[$x] === ')') {
                                         continue(2);

src/Tokenizers/Tokenizer.php

@@ -76,9 +76,9 @@ abstract class Tokenizer
     /**
      * Initialise and run the tokenizer.
      *
-     * @param string                         $content The content to tokenize.
-     * @param \PHP_CodeSniffer\Config | null $config  The config data for the run.
-     * @param string                         $eolChar The EOL char used in the content.
+     * @param string                       $content The content to tokenize.
+     * @param \PHP_CodeSniffer\Config|null $config  The config data for the run.
+     * @param string                       $eolChar The EOL char used in the content.
      *
      * @return void
      * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the file appears to be minified.

tests/ConfigDouble.php

@@ -41,7 +41,7 @@ final class ConfigDouble extends Config
      *                                              the ruleset auto-discovery.
      *                                              Note: there is no need to set this to `true` when a standard
      *                                              is being passed via the `$cliArgs`. Those settings will always
-     *                                              respected.
+     *                                              be respected.
      *                                              Defaults to `false`. Will result in the standard being set
      *                                              to "PSR1" if not provided via `$cliArgs`.
      * @param bool          $skipSettingReportWidth Whether to skip setting a report-width to prevent

tests/Core/File/GetMethodPropertiesTest.php

@@ -356,7 +356,7 @@ public function testReturnNamespace()
 
 
     /**
-     * Test a method with a messy namespaces return type.
+     * Test a method with a messy namespaced return type.
      *
      * @return void
      */

tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SetProperty/PropertyTypeHandlingSniff.php

@@ -2,7 +2,7 @@
 /**
  * Test fixture.
  *
- * @see \PHP_CodeSniffer\Tests\Core\Ruleset\SetSniffPropertyTest
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PropertyTypeHandlingTest
  */
 
 namespace Fixtures\TestStandard\Sniffs\SetProperty;

tests/Core/Ruleset/ProcessRulesetShouldProcessElementTest.php

@@ -88,7 +88,7 @@ protected function initializeConfigAndRuleset()
 
 
     /**
-     * Destroy the Config object and restor the ini values after the tests.
+     * Destroy the Config object and restore the ini values after the tests.
      *
      * @afterClass
      *

tests/Core/Tokenizers/PHP/AttributesTest.inc

@@ -62,7 +62,7 @@ function multiple_attributes_on_parameter_test(#[ParamAttribute, AttributeWithPa
 
 /* testFqcnAttribute */
 #[Boo\QualifiedName, \Foo\FullyQualifiedName('foo')]
-function fqcn_attrebute_test() {}
+function fqcn_attribute_test() {}
 
 /* testNestedAttributes */
 #[Boo\QualifiedName(fn (#[AttributeOne('boo')] $value) => (string) $value)]