diff --git a/.travis.yml b/.travis.yml index 85ab8f48..41fc5309 100644 --- a/.travis.yml +++ b/.travis.yml @@ -85,6 +85,7 @@ script: # Validate the xml files. # @link http://xmlsoft.org/xmllint.html - if [[ "$SNIFF" == "1" ]]; then xmllint --noout --schema ./vendor/squizlabs/php_codesniffer/phpcs.xsd ./Yoast/ruleset.xml; fi + - if [[ "$SNIFF" == "1" ]]; then xmllint --noout ./Yoast/Docs/*/*Standard.xml; fi # Check the code-style consistency of the xml files. - if [[ "$SNIFF" == "1" ]]; then diff -B --tabsize=4 ./Yoast/ruleset.xml <(xmllint --format "./Yoast/ruleset.xml"); fi # Validate the composer.json file. diff --git a/Yoast/Docs/Commenting/CodeCoverageIgnoreDeprecatedStandard.xml b/Yoast/Docs/Commenting/CodeCoverageIgnoreDeprecatedStandard.xml new file mode 100644 index 00000000..3a5ee941 --- /dev/null +++ b/Yoast/Docs/Commenting/CodeCoverageIgnoreDeprecatedStandard.xml @@ -0,0 +1,27 @@ + + + + + + + + @deprecated x.x + * @codeCoverageIgnore + */ +function deprecated_function() {} + ]]> + + + @deprecated x.x + */ +function deprecated_function() {} + ]]> + + + diff --git a/Yoast/Docs/Commenting/CoversTagStandard.xml b/Yoast/Docs/Commenting/CoversTagStandard.xml new file mode 100644 index 00000000..5895b588 --- /dev/null +++ b/Yoast/Docs/Commenting/CoversTagStandard.xml @@ -0,0 +1,110 @@ + + + + + + + + Class_Name::method_name + */ + function test_something() {} +} + ]]> + + + () + */ + function test_something() {} +} + ]]> + + + + + + + + + + + Name\Space\function_name + */ + function test_something() {} +} + ]]> + + + + + + + + @covers ::globalFunction + */ + function test_something() {} + + /** + * Testing... + * + * @coversNothing + */ + function test_something_else() {} +} + ]]> + + + @coversNothing + * @covers ::globalFunction + */ + function test_something() {} +} + ]]> + + + diff --git a/Yoast/Docs/Commenting/FileCommentStandard.xml b/Yoast/Docs/Commenting/FileCommentStandard.xml new file mode 100644 index 00000000..b4d2a193 --- /dev/null +++ b/Yoast/Docs/Commenting/FileCommentStandard.xml @@ -0,0 +1,204 @@ + + + + + + + + namespace Yoast\A\B; + +/** + * Class docblock. + */ +class { + ... + ]]> + + + /** + * File comment. + */ + +namespace Yoast\A\B; + +/** + * Class docblock. + */ +class { + ... + ]]> + + + + + + + + + /** + * File comment. + */ + +/** + * Class docblock. + */ +class { + ... + ]]> + + + +/** + * Class docblock. + */ +class { + ... + ]]> + + + + + + + + + /** + * File comment. + */ + ]]> + + + /* + * File comment. + */ + ]]> + + + + + + + + + +/** + * File comment. + */ + ]]> + + + + + +/** + * File comment. + */ + ]]> + + + + + + + + + + + echo $something; + ]]> + + + + echo $something; + ]]> + + + + + + + + + @package Yoast\Package + */ + ]]> + + + + + + + + + + + + @package Yoast\Package + */ + ]]> + + + @package + */ + ]]> + + + + diff --git a/Yoast/Docs/Commenting/TestsHaveCoversTagStandard.xml b/Yoast/Docs/Commenting/TestsHaveCoversTagStandard.xml new file mode 100644 index 00000000..aceea4f2 --- /dev/null +++ b/Yoast/Docs/Commenting/TestsHaveCoversTagStandard.xml @@ -0,0 +1,85 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Yoast/Docs/ControlStructures/IfElseDeclarationStandard.xml b/Yoast/Docs/ControlStructures/IfElseDeclarationStandard.xml new file mode 100644 index 00000000..505eb32f --- /dev/null +++ b/Yoast/Docs/ControlStructures/IfElseDeclarationStandard.xml @@ -0,0 +1,56 @@ + + + + + + + + +elseif ($bar) { + $var = 2; +} + ]]> + + + elseif ($bar) { + $var = 2; +} + ]]> + + + + + + + + elseif ($bar) { + $var = 2; +} + ]]> + + + else { + $var = 2; + } + ]]> + + + diff --git a/Yoast/Docs/Files/FileNameStandard.xml b/Yoast/Docs/Files/FileNameStandard.xml new file mode 100644 index 00000000..a43819e8 --- /dev/null +++ b/Yoast/Docs/Files/FileNameStandard.xml @@ -0,0 +1,86 @@ + + + + + + + + file-name.php + ]]> + + + File_Name.php + ]]> + + + + + + + + utils.php --> +Utils {} + ]]> + + + class-wpseo-utils.php --> + + + + + + + + + output-thing-interface.php --> +interface Yoast_Output_Thing {} + ]]> + + + yoast-outline-something.php --> +trait Yoast_Outline_Something {} + ]]> + + + + + + + + functions.php --> + + + + + + + + diff --git a/Yoast/Docs/Files/TestDoublesStandard.xml b/Yoast/Docs/Files/TestDoublesStandard.xml new file mode 100644 index 00000000..3b0d1ecb --- /dev/null +++ b/Yoast/Docs/Files/TestDoublesStandard.xml @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + + + + diff --git a/Yoast/Docs/Namespaces/NamespaceDeclarationStandard.xml b/Yoast/Docs/Namespaces/NamespaceDeclarationStandard.xml new file mode 100644 index 00000000..d5a548f4 --- /dev/null +++ b/Yoast/Docs/Namespaces/NamespaceDeclarationStandard.xml @@ -0,0 +1,62 @@ + + + + + + + + ; + ]]> + + + { + // Code. +} + ]]> + + + + + + + + + Yoast\Sub; + ]]> + + + ; + ]]> + + + + + + + + + + + + namespace Yoast\Sub\B { +} + ]]> + + + diff --git a/Yoast/Docs/WhiteSpace/FunctionSpacingStandard.xml b/Yoast/Docs/WhiteSpace/FunctionSpacingStandard.xml new file mode 100644 index 00000000..763901ad --- /dev/null +++ b/Yoast/Docs/WhiteSpace/FunctionSpacingStandard.xml @@ -0,0 +1,116 @@ + + + + + + + + + + /** + * Function docblock. + */ + function func1() { + } +} + ]]> + + + + /** + * Function docblock. + */ + function func1() { + } +} + ]]> + + + + + + + + + + + /** + * Function docblock. + */ + function func2() { + } +} + ]]> + + + + + + /** + * Function docblock. + */ + function func2() { + } + /** + * Function docblock. + */ + function func3() { + } +} + ]]> + + + + + + + + + +} + ]]> + + + + +} + ]]> + + + diff --git a/Yoast/Docs/Yoast/AlternativeFunctionsStandard.xml b/Yoast/Docs/Yoast/AlternativeFunctionsStandard.xml new file mode 100644 index 00000000..97742446 --- /dev/null +++ b/Yoast/Docs/Yoast/AlternativeFunctionsStandard.xml @@ -0,0 +1,20 @@ + + + + + + + + WPSEO_Utils:format_json_encode( $in ); + ]]> + + + wp_json_encode( $in ); + ]]> + + +