[英]How can I configure Doxygen to include typedefs of classes in the “Class Index”?
如何配置Doxygen在“类索引”网页中包含类的typedef? 例如,如果代码具有
typedef std::map<std::string /* month name */, std::string /* yield */> MonthlyYieldMap;
某个地方,那么MonthlyYieldMap
就像一个类,因此将其包括在类索引中似乎是合理的,就像引用该类的其他名称一样。
如果我正在检查其他人的代码,并且看到了像类一样但对我不熟悉的东西的名称,那么我会拉出“类索引”以查找该类的详细信息,但是如果该名称是typedef,那么它将没有显示。
我仍然可以通过Class Index网页上的Doxygen搜索栏找到有关神秘名称的信息,但是如果在Class Index中提及它,将会更加方便。
我浏览了配置文件,发现其中两个提到typedef(INLINE_SIMPLE_STRUCTS和TYPEDEF_HIDE_STRUCT),但是它们没有解决我的问题。
添加于2018-07-05:
如果可以编辑代码,则可以将typedef更改为继承另一个类的类:
class MonthlyYieldMap : public std::map<std::string, std::string> { }
然后将其包含在类索引中。 我不知道这样做是否会影响性能或可执行文件的大小。 如果我无法编辑代码,这将无济于事。
typedef
不是class
,因此无法预见。 一个不太好的解决方案,因为它没有提到MonthlyYieldMap
是一个typedef
而是说它是一个函数(我不接受您的情况):
/**
* @class MonthlyYieldMap
*/
/**
* some documentation
* \relates MonthlyYieldMap
*/
typedef std::map<std::string /* month name */, std::string /* yield */> MonthlyYieldMap;
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.