Skip to content

Generic/OpeningFunctionBraceBsdAllman: improve XML documentation #953

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 13, 2025
Merged

Generic/OpeningFunctionBraceBsdAllman: improve XML documentation #953

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eddb012
Generic/OpeningFunctionBraceBsdAllman: fix syntax errors in the XML d…
rodrigoprimo Apr 4, 2025
f647362
Generic/OpeningFunctionBraceBsdAllman: improve XML doc
rodrigoprimo Apr 9, 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/OpeningFunctionBraceBsdAllmanStandard.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 Bsd Allman">
<standard>
<![CDATA[
Function declarations follow the "BSD/Allman style". The function brace is on the line following the function declaration and is indented to the same column as the start of the function declaration.
Function declarations must follow the "BSD/Allman style". The opening brace is on the line
following the function declaration and is indented to the same column as the start of the
function declaration. The brace must be the last content on the line.
]]>
</standard>
<code_comparison>
<code title="Valid: Brace on next line.">
<code title="Valid: Opening brace on the next line.">
<![CDATA[
function fooFunction($arg1, $arg2 = '')
<em>{</em>
...
// Do something
}
]]>
</code>
<code title="Invalid: Brace on same line.">
<code title="Invalid: Opening brace on the same line.">
<![CDATA[
function fooFunction($arg1, $arg2 = '') <em>{</em>
...
// Do something
}
]]>
</code>
Expand Down
Loading