search

kunaltyagi / nsiqcppstyle

Cpp style checker in python
GNU General Public License v2.0
26 stars 24 forks source link

Doxygen "Qt style" /*! is considered as a violation #28

Closed BukDem closed 1 month ago

BukDem commented 3 years ago

Hi all,

we use Doxygen with the following syntax :

/*!
 * \fn          
 * \param   
 * \brief      
 */

But it is considered as violation by RULE_5_3_A ... Though it is a proper way to use Doxygen : https://www.doxygen.nl/manual/docblocks.html

Is it a big deal to fix?

Thanks a lot.

kunaltyagi commented 3 years ago

Comments are tokenized here: https://github.com/kunaltyagi/nsiqcppstyle/blob/36f852f4f43f5cb11902538e7dee77614d895d43/nsiqcppstyle_checker.py#L302-L322

Adding a similar tokenizer for Qt comments (and a bit of machinery) plus tests should be able to resolve the issue. Looking forwards to the PR