Skip to content
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

[Docs] Add XML doc for Squiz.Classes.ClassFileName sniff #843

Merged
merged 3 commits into from
Mar 7, 2025
Merged

[Docs] Add XML doc for Squiz.Classes.ClassFileName sniff #843

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cc01a79
Add XML doc for Squiz\Classes\ClassFileName sniff
braindawg Feb 23, 2025
1e8f5db
[Doc] Emphasize sniff focus for ClassFileName
braindawg Feb 25, 2025
f75039a
Correct file/class name relation in sniff doc
braindawg Mar 7, 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
47 changes: 47 additions & 0 deletions src/Standards/Squiz/Docs/Classes/ClassFileNameStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<documentation title="Class File Name">
<standard>
<![CDATA[
The file name and the name of the class defined within the file must match exactly, including case.
]]>
</standard>
<code_comparison>
<code title="Valid: Defined class name and filename match.">
<![CDATA[
/* ./src/<em>Foo.php</em> contents: */

class <em>Foo</em>
{
}
]]>
</code>
<code title="Invalid: Filename does not match class name.">
<![CDATA[
/* ./src/<em>Foo.php</em> contents: */

class <em>MyFoo</em>
{
}
]]>
</code>
</code_comparison>
<code_comparison>
<code title="Valid: Class name and filename use the same casing.">
<![CDATA[
/* ./src/<em>MyFoo.php</em> contents: */

class <em>MyFoo</em>
{
}
]]>
</code>
<code title="Invalid: Filename case does not match class name case.">
<![CDATA[
/* ./src/<em>myFoo.php</em> contents: */

class <em>MyFoo</em>
{
}
]]>
</code>
</code_comparison>
</documentation>