Fix up docs.

Author: dereuromark

PSR2R/Tools/Sniffer.php

@@ -36,30 +36,28 @@ Most likely you are using composer. As such, put it into the require-dev depende
 composer require --dev fig-r/psr2r-sniffer
 ```
 
-You can then use it like this:
-```
-// Sniffs only
-vendor/bin/sniff /path/to/your/files
+Set up a `phpcs.xml` in the root of your library.
+Define here the standard to use as well as the project paths, usually
+```xml
+<rule ref="vendor/fig-r/psr2r-sniffer/PSR2R/ruleset.xml"/>
 
-// Sniffs and fixes
-vendor/bin/sniff /path/to/your/files -f
+<file>src/</file>
+<file>tests/</file>
 ```
-The path is optional if you want to run it on your complete project root dir. It will in this case automatically skip the `vendor/` dir.
 
-#### Examples
-If you want to run the sniffer over your root `src/` folder, run:
-```
-vendor/bin/sniff src/
+You can then use it like this:
 ```
+// Sniffs only
+vendor/bin/phpcs {path/file}
 
-Use `-h` to list all available options.
-But with this bin tool the path needs to always come first (it does not work otherwise):
-```
-vendor/bin/sniff /path/to/files [optional params]
+// Sniffs and fixes
+vendor/bin/phpcbf {path/file}
 ```
+The path is optional if you want to run it on a specific subset of your defined paths.
+Otherwise, it defaults to the paths defined in your XML file.
 
 ### Customizing
-You can always customize on project level using your own `phpcs.xml` file there, e.g.:
+You can always customize your `phpcs.xml` further, e.g.:
 
 ```xml
 <?xml version="1.0"?>
@@ -83,7 +81,7 @@ You can always customize on project level using your own `phpcs.xml` file there,
 		<severity>0</severity>
 	</rule>
 
-	<!-- Define your own sniffs here -->
+	<!-- Define your own additional sniffs here -->
 
 </ruleset>
 ```
@@ -94,24 +92,24 @@ Verbose output with `-v` is always useful. With `-vv` or even `-vvv` you get eve
 
 If you want a list of all sniffs in this standard, use `-e`:
 ```
-vendor/bin/sniff -e
+vendor/bin/phpcs -e
 ```
 It will list them all grouped by their standard name and sniff type.
 
-To just run a single sniff, use `--sniffs=...` and a comma separated list of sniffs, .e.g.:
+To just run a single sniff, use `--sniffs=...` and a comma separated list of sniffs, e.g.:
 ```
-vendor/bin/sniff --sniffs=PSR2R.Files.EndFileNewline
+vendor/bin/phpcs --sniffs=PSR2R.Files.EndFileNewline
 ```
 
 Usually, if you run it over your complete repository, you would want to exclude dirs like `tests/test_files/`:
 ```
-vendor/bin/sniff --ignore=tests/test_files/
+vendor/bin/phpcs --ignore=/tests/test_files/
 ```
 
 #### Windows usage
 For Win OS you should be using `\` as separator:
 ```
-vendor\bin\sniff -v
+vendor\bin\phpcs
 ```
 
 #### Include it in your IDE via hotkey

README.md

@@ -7,9 +7,10 @@
     <file>PSR2R/</file>
     <file>docs/</file>
     <file>bin/</file>
+	<file>tests/Sniffs/</file>
 
     <rule ref="PSR2R"/>
 
-    <exclude-pattern>/tests/files/,*.inc,*.fixed</exclude-pattern>
+    <exclude-pattern>,*.inc,*.fixed</exclude-pattern>
 
 </ruleset>

phpcs.xml

@@ -9,8 +9,6 @@ class FullyQualifiedClassNameInDocBlockSniffTest extends TestCase {
 
 	/**
 	 * @return void
-	 * @throws \PHPUnit_Framework_AssertionFailedError
-	 * @throws \PHPUnit_Framework_Exception
 	 */
 	public function testInstance() {
 		$this->assertTrue(class_exists(FullyQualifiedClassNameInDocBlockSniff::class));

tests/Sniffs/Commenting/FullyQualifiedClassNameInDocBlockSniffTest.php

@@ -7,19 +7,17 @@
 class FullyQualifiedClassNameInDocBlockUnitTest extends AbstractSniffUnitTest {
 
 	/**
-	 * {@inheritDoc}
+	 * @inheritDoc
 	 */
-	public function getErrorList()
-	{
+	public function getErrorList() {
 		return [
 			//9 => 1,
 		];
 	}
 	/**
-	 * {@inheritDoc}
+	 * @inheritDoc
 	 */
-	public function getWarningList()
-	{
+	public function getWarningList() {
 		return [
 		];
 	}