Skip to content

Generic/OpeningFunctionBraceKernighanRitchie: improve XML documentation #927

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

Generic/OpeningFunctionBraceKernighanRitchie: improve XML documentation #927

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
65c9409
Generic/OpeningFunctionBraceKernighanRitchie: fix syntax errors in th…
rodrigoprimo Apr 4, 2025
c58487e
Generic/OpeningFunctionBraceKernighanRitchie: improve XML doc
rodrigoprimo Apr 4, 2025
0ba39b2
Implement suggestion from code review (avoid empty function body in t…
rodrigoprimo Apr 4, 2025
eab56f5
Revert to use "function declaration" instead of "function declaration
rodrigoprimo Apr 7, 2025
c2d6e35
Update src/Standards/Generic/Docs/Functions/OpeningFunctionBraceKerni…
rodrigoprimo Apr 7, 2025
33c4760
Further improve the description of the standard based on PR review di…
rodrigoprimo Apr 8, 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
14 changes: 8 additions & 6 deletions src/Standards/Generic/Docs/Functions/OpeningFunctionBraceKernighanRitchieStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@
<documentation title="Opening Brace in Function Declarations">
<documentation title="Opening Function Brace Kerninghan Ritchie">
<standard>
<![CDATA[
Function declarations follow the "Kernighan/Ritchie style". The function brace is on the same line as the function declaration. One space is required between the closing parenthesis and the brace.
The function opening brace must be on the same line as the end of the function declaration, with
exactly one space between the end of the declaration and the brace. The brace must be the last
content on the line.
]]>
</standard>
<code_comparison>
<code title="Valid: Brace on same line.">
<code title="Valid: Opening brace on the same line.">
<![CDATA[
function fooFunction($arg1, $arg2 = '')<em> {</em>
...
// Do something.
}
]]>
</code>
<code title="Invalid: Brace on next line.">
<code title="Invalid: Opening brace on the next line.">
<![CDATA[
function fooFunction($arg1, $arg2 = '')
<em>{</em>
...
// Do something.
}
]]>
</code>
Expand Down