How to show C++ style include syntax in doxygen

Question

I am putting doxygen comment in my file. When I generat HTML files (using doxygen application) I can see

MyClass Class Reference

#include <myclass.hpp>

Which I want to display like

MyClass Class Reference

#include <MyClass>

I tried various option but no luck. I tried \file MyClass, but still showing same (above mentioned) line.

Here is doxygen comment

/** * \class MyClass * * \ingroup demo * * \brief Provide an example * * This class is meant as an example. It is not useful by itself * rather its usefulness is only a function of how much it helps * the reader. It is in a sense defined by the person who reads it * and otherwise does not exist in any real form. * * \file MyClass * * Contact: [email protected] * * Created on: Wed Apr 13 18:39:37 2005 * */

what is the file named as?

P.W
– P.W

2019-04-16 09:04:53 +00:00
Commented Apr 16, 2019 at 9:04 — P.W
– P.W, Commented Apr 16, 2019 at 9:04

Nellie Danielyan · Accepted Answer · 2019-04-16 09:28:03Z

From Doxygen FAQ:

You can also document your class as follows
/*! \class MyClassName include.h path/include.h * * Docs for MyClassName */ 
To make doxygen put

#include <path/include.h>

in the documentation of the class MyClassName regardless of the name of the actual header file in which the definition of MyClassName is contained.

So I would try:

/** * \class MyClass myclass.hpp MyClass ... */

Collectives™ on Stack Overflow

How to show C++ style include syntax in doxygen

1 Answer 1

Comments

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Related