标签: doxygen

我记录了所有类,现在我想集成一个如何使用这些类的示例.我怎么做？

我想在C++中为新项目试用文档生成器.我认为我的选择是Doxygen或Sphinx.由于我有Python项目,我想使用Sphinx,我想知道Sphinx是否也是C++的正确选择.该狮身人面像的网站指出,支持C++,但是我找不到让我开始用C++文档的文档.

Stackoverflow上已经讨论过类似的问题,主要答案是:

尚未完全使用,
但继续观看

由于讨论已经超过一年了,我想知道这个结论是否仍然有效.我应该选择Doxygen而不是Sphinx作为我的C++文档吗？

我想弄清楚是否有办法使用Doxygen创建自定义标签.我确实找到了ALIAS配置文件选项,但这并不能完全满足我的需要.基本上在我的代码中,我希望能够编写类似的东西

/// \req Requirement #322 - blah blah

再有Doxygen的创建列表像它的\bug,并\todo具有此定制标记线命令.Doxygen可以实现吗？

当我以PDF格式生成Doxygen文档时,我会获得大量不同的文件,每个文件都有一个图表.
是否有可能获得单个PDF文档,组织为书籍,大致与HTML版本一样？
是否可以自动获取,即​​无需手动处理乳胶文件？

谢谢!

我花了一些时间来审阅文档并从头到尾浏览我的doxy配置文件.我在配置文件中剪切了doxygen,它为结构和cpp类生成文档和索引,但是我没有在源代码树中看到大量c函数的调用或调用图.

任何人都可以告诉我如何配置doxygen来产生这些呼叫和呼叫者树？我确实安装了graphviz.

如何在Xcode中为我自己的代码创建快速帮助条目？我只是想把它作为编码支持,就像编写Java时的Eclipse功能一样.在eclipse中,当您将方法悬停在其他位置时,您会在方法上方输入注释.

Xcode等效似乎是"快速帮助".

除了使用Doxygen之外真的没别的办法吗？对于我正在研究的小项目来说,Doxygen似乎有些过分.目前我确实知道我只想彻底填写快速帮助,所以请避免任何提示,"你必须为你的项目创建一个文档".

我真的很感激任何帮助,因为我在这个主题上唯一能找到的就是这个问题.

但正如您所看到的,没有可用的解决方案.

我正在尝试使用Github页面来托管Doxygen站点.理想情况下,我希望能够将生成的文件和目录推送到Github而不必完全调整它们.但是,这意味着我的index.html位于存储库的子文件夹中,并且Github Pages没有提取它(当我尝试访问Pages网站时,我得到404).有没有办法让Github在子文件夹中识别index.html？这是一个项目网站.

我正在寻找一个用于doxygen代码文档的eclipse插件.我找到了eclox-plugIn(http://home.gna.org/eclox/).我想知道,它怎么能自动生成一个"空"的doxygen注释,可以在以后填写,或者什么是文档eclipse插件的更好选择？

例如对于函数:void f(int p1,int p2,...),它应该生成:

/*! \brief ...
    \param p1 ...
    ..
*/ 

PS我主要用于c/c ++语言

鉴于:

namespace Foo {
    class Foo {
    public:
        /// Foo enum, possible ways to foo
        enum class Foo {
            /// Foo it with an A
            A,
            /// Foo it with a B
            B,
            /// Foo it with a C
            C
        }
    }
}

和默认的Doxyfile doxygen -g,我得到这个:

如何记录枚举值？我尝试在成员之前/之后发表评论,使用///<等等都无济于事.可能这只是doxygen中的一个错误？文档中的示例有效.(点击枚举名称不会带我到任何地方)

我们正在travis-ci服务器上编译Doxygen文档,并希望将它们推送到我们的gh-pages分支.

我该如何处理授权git push？有人在travis-ci中有一个使用加密变量的例子吗？我应该使用https授权还是SSH密钥？