Skip to content

Generic/RequireStrictTypes: add XML documentation #236

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

Merged
merged 4 commits into from
Feb 24, 2024
Merged

Generic/RequireStrictTypes: add XML documentation #236

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
13ee209
Generic/RequireStrictTypes: add XML documentation
rodrigoprimo Jan 5, 2024
6203a1b
Rough draft of how the docs look like separating the two rules
rodrigoprimo Jan 15, 2024
70bea75
Generic/RequireStrictTypes: improve docs based on PR review suggestions
rodrigoprimo Feb 23, 2024
c7f8834
Generic/RequireStrictTypes: further improvements to the docs
rodrigoprimo Feb 23, 2024
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
38 changes: 38 additions & 0 deletions src/Standards/Generic/Docs/PHP/RequireStrictTypesStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<documentation title="Require Strict Types">
<standard>
<![CDATA[
The strict_types declaration must be present.
]]>
</standard>
<code_comparison>
<code title="Valid: strict_types declaration is present.">
<![CDATA[
declare(<em>strict_types=1</em>);

declare(encoding='UTF-8', <em>strict_types=0</em>);
]]>
</code>
<code title="Invalid: Missing strict_types declaration.">
<![CDATA[
declare(encoding='ISO-8859-1'<em></em>);
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
The strict_types declaration must be enabled.
]]>
</standard>
<code_comparison>
<code title="Valid: strict_types declaration is enabled.">
<![CDATA[
declare(strict_types=<em>1</em>);
]]>
</code>
<code title="Invalid: strict_types declaration is disabled.">
<![CDATA[
declare(strict_types=<em>0</em>);
]]>
</code>
</code_comparison>
</documentation>