Commit 389f01c
committed
Bug#33734206 doc-comment warning in sql/
Issue
=====
clang -Wdocumentation reports:
sql/sql_class.cc:3213:4: warning: '@returns' command used in a comment
that is attached to a function returning void [-Wdocumentation]
Doxygen's param command is spec'ed as:
@param '['dir']' <parameter-name> { parameter description }
which makes [out] in:
@param new_item [out] return new_item, if created
part of the param-description, instead of 'dir'.
Change
======
- @param name [in] -> @param[in] name
- use @returns instead of @RetVal when no value is specified
- removed empty @returns
- @param name [out] -> @param[out] name
RB: 275481 parent 7700dab commit 389f01c
3 files changed
+8
-16
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
| |||
125 | 125 | | |
126 | 126 | | |
127 | 127 | | |
128 | | - | |
| 128 | + | |
129 | 129 | | |
130 | | - | |
131 | | - | |
| 130 | + | |
132 | 131 | | |
133 | 132 | | |
134 | 133 | | |
| |||
1815 | 1814 | | |
1816 | 1815 | | |
1817 | 1816 | | |
1818 | | - | |
1819 | | - | |
1820 | | - | |
| 1817 | + | |
| 1818 | + | |
1821 | 1819 | | |
1822 | 1820 | | |
1823 | 1821 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
| |||
5637 | 5637 | | |
5638 | 5638 | | |
5639 | 5639 | | |
5640 | | - | |
| 5640 | + | |
5641 | 5641 | | |
5642 | 5642 | | |
5643 | 5643 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
| 2 | + | |
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
| |||
3200 | 3200 | | |
3201 | 3201 | | |
3202 | 3202 | | |
3203 | | - | |
3204 | | - | |
3205 | 3203 | | |
3206 | 3204 | | |
3207 | 3205 | | |
| |||
3215 | 3213 | | |
3216 | 3214 | | |
3217 | 3215 | | |
3218 | | - | |
3219 | | - | |
3220 | 3216 | | |
3221 | 3217 | | |
3222 | 3218 | | |
| |||
3241 | 3237 | | |
3242 | 3238 | | |
3243 | 3239 | | |
3244 | | - | |
3245 | | - | |
3246 | 3240 | | |
3247 | 3241 | | |
3248 | 3242 | | |
| |||
0 commit comments