Doxygen和长类名

时间:2015-06-27 23:55:40

标签: c++ doxygen

我有一个很好的C ++项目,其中模板编程被广泛使用,但这不是重点。关键是我的一些类名(包含所有模板参数)变得很长。我使用Doxygen作为文档。

这通常不是问题,但最近我注意到类列表不可读,因为长类名称太宽而无法放在屏幕上。

有没有办法让类列表中的类的Doxygen中断名称更多?是否有一种方法可以在保留常规模板类的同时隐藏类列表中模板类的特化?有更好的解决方案吗?

我设法通过将类隐藏在命名空间中然后立即将此命名空间导入全局命名空间来找到一个愚蠢的解决方法,以便这些类的名称不会出现在列表中,除非点击命名空间或细节水平提高了。明显的缺点是这些课程现在没有出现在名单上(其中一些非常重要,我希望他们在那里)。

我还可以删除以下样式:

.directory td.entry {
    white-space: nowrap;
}

这可以通过保存:

来完成
.directory td.entry {
    white-space: normal;
}

modify.css并在HTML_EXTRA_STYLESHEET下指定。但是,有更多的自动换行标签(例如flex-wrap),因此可能需要进行额外的编辑。

1 个答案:

答案 0 :(得分:2)

最后,我去了修改css。我最终使用了:

.directory td.entry {
    white-space: normal;
    /*width: 50%;*/ /* does not work, makes "Related Pages" look bad */
    min-width: 512px; /* better, unless you have a 640x480 screen */
}

我将其保存为doxygen_modify.css并在HTML_EXTRA_STYLESHEET中指定了它的路径(请注意,如果命名为doxygen.css,则不会自动重命名,而是将其替换为主样式表 - 因此您不会看到任何更改。)