Skip to content

Generic/UselessOverridingMethod: improve XML documentation #922

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 2 commits into from
Apr 2, 2025
Merged

Generic/UselessOverridingMethod: improve XML documentation #922

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
389a461
Generic/UselessOverridingMethod: fix syntax errors in the documentation
rodrigoprimo Apr 1, 2025
52dd82b
Generic/UselessOverridingMethod: improve documentation description and
rodrigoprimo Apr 1, 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
12 changes: 6 additions & 6 deletions src/Standards/Generic/Docs/CodeAnalysis/UselessOverridingMethodStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<documentation title="Useless Overriding Methods">
<documentation title="Useless Overriding Method">
<standard>
<![CDATA[
Methods should not be defined that only call the parent method.
It is discouraged to override a method if the overriding method only calls the parent method.
]]>
</standard>
<code_comparison>
<code title="Valid: A method that extends functionality on a parent method.">
<code title="Valid: A method that extends functionality of a parent method.">
<![CDATA[
final class Foo
final class Foo extends Baz
{
public function bar()
{
Expand All @@ -17,9 +17,9 @@ final class Foo
}
]]>
</code>
<code title="Invalid: An overriding method that only calls the parent.">
<code title="Invalid: An overriding method that only calls the parent method.">
<![CDATA[
final class Foo
final class Foo extends Baz
{
public function bar()
{
Expand Down