How do I get Doxygen to "bind" to enumerations?

I have the following code:

/// \file Doxygen_tests.h /** * * \enum Tick_Column_Type * * \brief Values that represent Tick_Column_Type. **/ enum Tick_Column_Type { TC_OPEN, ///< Opening price TC_HIGH, ///< High price TC_MAX, ///< Required as last enum marker. }; /** * * \struct Tick_Data_Row * * \brief Holder for one row or snapshot of tick data. * **/ struct __declspec (dllexport) Tick_Data_Row { Tick_Data_Row (); ///< Constructor. Sets all columns to NaN void init (); ///< Helper function to reset everything to NaN double m_cols[TC_MAX]; ///< The data. Indexed by Tick_Column_Type. }; 

Everything seems to be working fine (the listing ends in the file area, but I have a file \, so it appears along with the descriptions, it is formatted correctly.

What I want (and does not happen) is that I need a link to Tick_Column_Type in the documentation for Tick_Data_Row :: m_cols to link to this page of the document. Doxygen usually seems pretty smart at defining "yeah, that is the name that I know, I will bind it," but in this case he cannot do it.

It doesn’t matter if the enumeration moves within the structure.

Any clues?

+5
source share
1 answer

From documents (automatic link creation) : go to

 ///< The data. Indexed by Tick_Column_Type. 

in

 ///< The data. Indexed by ::Tick_Column_Type. 
+8
source

Source: https://habr.com/ru/post/1302377/


All Articles