Commit 7be3761
Generic/OpeningFunctionBraceKernighanRitchie: improve XML documentation (#927)
* Generic/OpeningFunctionBraceKernighanRitchie: fix syntax errors in the XML doc code examples
* Generic/OpeningFunctionBraceKernighanRitchie: improve XML doc
- `<documentation>` title matches the sniff name.
- Don't mention the Kernighan/Ritchie style in the `<standard>`
description as according to Wikipedia this style uses the opening brace
for functions on a separate line and not on the same line (https://en
.wikipedia.org/wiki/Indentation_style#K&R).
- I believe it is more precise to say that the sniff checks if the
opening brace is on the same line as the closing parenthesis and not the
function declaration as the function declaration can be multi-line.
- Mention in the `<standard>` description that there must be no content
on the line after the opening brace.
- Improve the title of the `<code>` blocks.1 parent 4b03364 commit 7be3761
File tree
1 file changed
+8
-6
lines changed- src/Standards/Generic/Docs/Functions
1 file changed
+8
-6
lines changedLines changed: 8 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
5 | 7 | | |
6 | 8 | | |
7 | 9 | | |
8 | | - | |
| 10 | + | |
9 | 11 | | |
10 | 12 | | |
11 | | - | |
| 13 | + | |
12 | 14 | | |
13 | 15 | | |
14 | 16 | | |
15 | | - | |
| 17 | + | |
16 | 18 | | |
17 | 19 | | |
18 | 20 | | |
19 | | - | |
| 21 | + | |
20 | 22 | | |
21 | 23 | | |
22 | 24 | | |
| |||
0 commit comments