We have an issue an issue with globals XML documentation. For instance, the following code define in enum.h:
/*! \file enum.h
Short description of a file containing a global enum.
Long description of a file containing a global enum.
*/
#ifndef ENUM_H
#define ENUM_H
namespace mi {
/// Short description of a global enum.
/// Long description of a global enum.
enum Global_enum {
/// Short description of a global enum value.
/// Long description of a global enum value.
global_enum_value,
/// Short description of a global enum value with initializer.
/// Long description of a global enum value with initializer.
global_enum_value_initialized = 5
};
} // namespace mi
#endif // ENUM_H
will generate the expected html output in enum_8h.html. However, in the xml output, enum_8h.xml does not mention Global_enum as we would have expected. I have just tried Doxygen 1.5.8 without any success.
Is this a bug or do we have a problem with our settings?
Thanks.
Nicolas
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Hi,
We have an issue an issue with globals XML documentation. For instance, the following code define in enum.h:
/*! \file enum.h
Short description of a file containing a global enum.
Long description of a file containing a global enum.
*/
#ifndef ENUM_H
#define ENUM_H
namespace mi {
/// Short description of a global enum.
/// Long description of a global enum.
enum Global_enum {
/// Short description of a global enum value.
/// Long description of a global enum value.
global_enum_value,
/// Short description of a global enum value with initializer.
/// Long description of a global enum value with initializer.
global_enum_value_initialized = 5
};
} // namespace mi
#endif // ENUM_H
will generate the expected html output in enum_8h.html. However, in the xml output, enum_8h.xml does not mention Global_enum as we would have expected. I have just tried Doxygen 1.5.8 without any success.
Is this a bug or do we have a problem with our settings?
Thanks.
Nicolas
Global_enum is not global. By the C++ standard, and thus by Doxygen standards, it is a member of the namespace "mi".