tiennm99/styleguide
1
0
Fork 0
mirror of https://github.com/tiennm99/styleguide.git synced 2026-09-04 06:20:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

In cpplint, permit Dodxygen C++ annotations, which come after members, e.g.

Browse Source 
int var; //!< Brief description after the member
or
  int var; ///< Brief description after the member

Cf. http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#memberdoc

Currently, cpplint accepts comments after members, cf.
http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml?showone=Implementation_Comments#Implementation_Comments
and it accepts also the doxygen comments of the type "///" (followed by a new line) and
"/// " (followed by a comment). Only the Doxygen annotations, which come
after members are rejected, which is fixed by this patch.

Review URL: https://codereview.appspot.com/14607044

Patch from Tobias Burnus <burnus@net-b.de>.
This commit is contained in:
erg@google.com
2013-10-31 19:46:18 +00:00
parent 2aa5998d82
commit 6d8d983b11
2 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cpplint/cpplint_unittest.py
+10
View File
@@ -2202,9 +2202,19 @@ class CpplintTest(CpplintTestBase):
self.TestLint('//////', '')
self.TestLint('////// x', '')
self.TestLint('/// x', '')
self.TestLint('///< x', '') # After-member Doxygen comment
self.TestLint('//!< x', '') # After-member Doxygen comment
self.TestLint('///', '') # Empty Doxygen comment
self.TestLint('////x', 'Should have a space between // and comment'
' [whitespace/comments] [4]')
self.TestLint('//!<x', 'Should have a space between // and comment'
' [whitespace/comments] [4]')
self.TestLint('///<x', 'Should have a space between // and comment'
' [whitespace/comments] [4]')
self.TestLint('//!<', 'Should have a space between // and comment'
' [whitespace/comments] [4]')
self.TestLint('///<', 'Should have a space between // and comment'
' [whitespace/comments] [4]')
# Test a line preceded by empty or comment lines. There was a bug
# that caused it to print the same warning N times if the erroneous