[英]How to document enumeration values with same name with Doxygen?
我正在尝试记录两个包含与Doxygen相似的值的类枚举。 但这会为每个具有相同名称的字段生成重复文本。
这是我的两个枚举:
/*!
* \enum OperandType
* \brief A type of operand. Represents the location of the operand.
*/
enum class OperandType : unsigned int {
IMMEDIATE, /**< An immediate operand */
REGISTER, /**< An operand in a register */
STACK, /**< An operand on the stack */
GLOBAL /**< A global operand */
};
/*!
* \enum PositionType
* \brief A type of position for a variable
*/
enum class PositionType : unsigned int {
STACK, /**< A variable on the stack */
PARAMETER, /**< A parameter */
GLOBAL, /**< A global variable */
CONST /**< A const variable.*/
};
每个枚举的STACK成员的描述都是两个描述的串联,对于GLOBAL存在相同的问题。
STACK的描述是:
堆栈上的变量
堆栈上的操作数
有没有办法专门记录每个文件?
解决方法是把它放在一个命名空间,并using
带出来。
/*!
* enum class
*/
namespace enum_class {
/*!
* \enum OperandType
* \brief A type of operand. Represents the location of the operand.
* Ok
*/
enum class OperandType : unsigned int {
IMMEDIATE, /**< An immediate operand */
REGISTER, /**< An operand in a register */
STACK, /**< An operand on the stack */
GLOBAL /**< A global operand */
};
}
using enum_class::OperandType;
/*!
* \enum PositionType
* \brief A type of position for a variable
*/
enum class PositionType : unsigned int {
STACK, /**< A variable on the stack */
PARAMETER, /**< A parameter */
GLOBAL, /**< A global variable */
CONST /**< A const variable.*/
};
如果您不喜欢分离,可以将PositionType
放在单独的命名空间( enumeration
)中。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.