Skip to content

[Docs] Add XML doc for Squiz.Classes.ClassDeclaration sniff #844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: 3.x
Choose a base branch
from
Draft

[Docs] Add XML doc for Squiz.Classes.ClassDeclaration sniff #844

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05b23e9
[Doc] Add XML doc for Squiz ClassDeclaration sniff
braindawg Feb 25, 2025
2a5c3e3
Merge branch 'PHPCSStandards:master' into DocXMLSquizClassesClassDecl…
braindawg May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 107 additions & 0 deletions src/Standards/Squiz/Docs/Classes/ClassDeclarationStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
<documentation title="Class Declaration">
<standard>
<![CDATA[
Only one interface or class is allowed in a file.
]]>
</standard>
<code_comparison>
<code title="Valid: One class declaration per file.">
<![CDATA[
class Foo implements Bar
{
}
]]>
</code>
<code title="Invalid: More than one class or interface per file.">
<![CDATA[
<em>class Foo implements Bar</em>
{
}

<em>interface Bar</em>
{
}
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
No whitespace allowed before the class declaration keywords.
]]>
</standard>
<code_comparison>
<code title="Valid: No whitespace before class declaration keywords.">
<![CDATA[
<em></em>abstract class Foo
{
}
]]>
</code>
<code title="Invalid: Whitespace before class declaration
keywords.">
<![CDATA[
<em> </em>abstract class Foo
{
}
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
Closing brace of a class or interface must be followed by a single blank line.
]]>
</standard>
<code_comparison>
<code title="Valid: Single blank line after closing brace.">
<![CDATA[
class Foo
{
}
<em></em>
]]>
</code>
<code title="Invalid: No blank line after closing brace.">
<![CDATA[
class Foo
{
}<em></em>
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
Closing brace of a class or interface must be on a line by itself.
]]>
</standard>
<code_comparison>
<code title="Valid: Closing brace is on a line by itself.">
<![CDATA[
class Foo
{
<em>}</em>
]]>
</code>
<code title="Invalid: Closing brace is not on a line by itself.">
<![CDATA[
class Foo
{<em>}</em>
]]>
</code>
</code_comparison>
<code_comparison>
<code title="Valid: No whitespace before closing brace.">
<![CDATA[
class Foo
{
<em>}</em>
]]>
</code>
<code title="Invalid: Whitespace before closing brace.">
<![CDATA[
class Foo
{
<em> </em>}
]]>
</code>
</code_comparison>
</documentation>