1,079
edits
Difference between revisions of "Code Formatting Conventions"
Code Formatting Conventions (view source)
Revision as of 18:31, 8 October 2009
, 18:31, 8 October 2009→Doxygen documentation comments: Changed //!< to ///< as proposed on -devel
m (→Hugging braces: remove parentheses in the class definition here too...) |
(→Doxygen documentation comments: Changed //!< to ///< as proposed on -devel) |
||
| Line 226: | Line 226: | ||
If you want to add a brief explanation of a variable or function ''after'' its declaration, this is the correct syntax: | If you want to add a brief explanation of a variable or function ''after'' its declaration, this is the correct syntax: | ||
<syntax type="C++"> | <syntax type="C++"> | ||
int16 x; // | int16 x; ///< The horizontal part of the point | ||
int16 y; // | int16 y; ///< The vertical part of the point | ||
</syntax> | </syntax> | ||
(See [http://doxygen.scummvm.org/d7/d66/structCommon_1_1Point.html#2d868735aeaaf391ce9b3df9232c031f here] for the docs generated from this.) | (See [http://doxygen.scummvm.org/d7/d66/structCommon_1_1Point.html#2d868735aeaaf391ce9b3df9232c031f here] for the docs generated from this.) | ||