File tree Expand file tree Collapse file tree 1 file changed +3
-3
lines changed
source/The-ROS2-Project/Contributing Expand file tree Collapse file tree 1 file changed +3
-3
lines changed Original file line number Diff line number Diff line change @@ -163,10 +163,10 @@ Doxygen Comments
163
163
~~~~~~~~~~~~~~~~
164
164
165
165
* While it is allowed to use ``/** */ `` style comments for documentation, we prefer ``/// `` style
166
- comments for Doxygen
166
+ comments for Doxygen.
167
167
168
- * rationale: ``/// `` is more consistent with the rest of the C++ code
169
- * rationale: ``/// `` is easier to type and read in most editors
168
+ * rationale: ``/// `` is more consistent with the rest of the C++ code.
169
+ * rationale: ``/// `` is easier to type and read in most editors.
170
170
* rationale: The Doxygen comments with ``/// `` is easier to read in the code itself, as it is
171
171
more compact versus ``/** */ `` which takes up more space and requires more lines.
172
172
* Note that using ``/** */ `` Doxygen comments is useful in cases when C++ header files could
You can’t perform that action at this time.
0 commit comments