Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Suppress doxygen warning for undocumented member function, but leave synopsis in place

Tags:

doxygen

I'm looking for a way to suppress doxygen warnings about undocumented member functions, but without using //! @cond and //! @endcond, so the member functions still appear in the synopsis of the class. Something like the following:

class Foo
{
public:
    Foo();
    Foo(const Foo&);
    Foo& operator=(const Foo&);
};

These member functions do the obvious thing and don't need documentation, but I still want them to appear in the list of available member functions in the documentation (because knowing that a class is copyable/assignable matters). As is, doxygen emits a "not documented" warning for each of these. If I use //! @cond and //! @endcond, the methods disappear completely from the documentation. What I would like is for the methods to remain visible in the documentation, but without any further comments, and I want oxygen to not complain about them being undocumented.

Is there some kind of "dummy comment" to tell doxygen to shut up about the lack of doc, but still preserve the methods in the documentation, so they are visible?

like image 202
Michi Henning Avatar asked Jun 07 '13 21:06

Michi Henning


1 Answers

You just need to add brackets. This works for me:

//! \{
const int myVar3 = 3;
const int myVar4 = 3;
//! \}

There is no warning and it still appears in the output. You may alias this commants to \nowarn and \endnowarn if you like.

like image 51
kuga Avatar answered Oct 28 '22 15:10

kuga