doxygen相关内容
我想就如何最好地为混合Java / Scala项目自动生成文档提供一些建议。我们正在使用Scala 2.8;似乎2.8.1附带的scaladoc工具不会为我们的Java类生成可用的文档-它获得正确的结构,但不包含文档。而且Javadoc显然只涵盖Java部分。 我们研究了Doxygen,但它与Scala一起使用时无法使用,因此这是一个研究项目。 如果不使用100%Java或100%Sc
..
我在doxygen中使用点和Graphviz来创建HTML代码的用户手册。 doxygen代码看起来像这样: / **
* @ addtogroup MainProgram * @ dot *有向图G { * Main [label =“ Main()”]; * START [label =“开始”]; *完成[label =“完成”]; * * S
..
我已设置 SOURCE_BROWSER = NO 和 VERBATIM_HEADERS = YES ,因为我希望客户能够看到标题文件。但是,我只想允许他们看到某些标题。 在此先感谢您的帮助! EDIT :这似乎有用,但是我对其他更好的方法也很感兴趣。 EXCLUDE_PATTERNS = * /。svn / * *调试* * impl * *提升* 解决方案 如
..
我无法在Doxygen文档中包括任何文本文件。唯一的例外是我设置为主页的 README.md 文件。 特别是,我会希望查看文档中的 Changelog.txt 文件。我试图将其显式添加到 INPUT 字段和 FILE_PATTERNS 字段中,但没有成功。在生成的HTML文档中,我无法在文件列表中找到任何内容,也无法进行搜索。 唯一的踪迹是在Doxygen的日志文件中: 预处理C
..
我有几个html页面,它们解释了我代码的不同部分,最近我还对其运行了Doxygen。我想在Doxygen的“相关页面”页面下添加到当前html页面的链接。 除了手动插入它们之外,还有其他方法吗? 解决方案 查看Doxygen页面命令文档: 链接
..
我有一个简单的问题:如何记录.INI文件? 我有一个C ++项目,其布局如下: readme.txt src main.cpp 数据 simple.ini 我没有问题,可以从readme.txt和main.cpp生成文档,但是simple.ini中的文档不会显示在html中输出。我更正了Doxygen文件,使其包含以下内容: INPUT =。
..
通常它会忽略未记录的C文件,但是我想测试Callgraph功能,例如,您知道不改变C文件的方法吗? 解决方案 在Doxyfile中设置变量 EXTRACT_ALL = YES 。
..
我有两个C源文件。在文件 A 中对函数 bar()的注释需要引用函数 foo ()在文件 B 中。我怎么做这个链接? 我试过: 编写如下内容: Bc :: foo()希望doxygen将转到文件 B 并找到函数 foo 那里。 还尝试了 :: foo()但这没有帮助。 然后我尝试为文件 Bc 赋予特殊的标记名,如下所示在做 //!在 Bc 的第一行上@file specia
..
在doxygen中,我写: / *!示例: 代码{.cpp} void main(int argc,char ** argv) { if(argc
..
我有一个C ++模板化类 base :: Foo ,在另一个文件中我有一个类 base :: bar: :Foo:公共基础:: Foo 。 Doxygen似乎不喜欢这样,因为它会引发错误 :1:在类之间检测到潜在的递归类关系snLib :: mocTwod :: DsaCell和基类DsaCell
..
我有一个简单的方法,带有注释,我想在doxygen主页上用作示例: \code void showNum(int numToDisplay){ //这只是一种显示值的方法。 std :: cout
..
我不明白为什么找不到由doxygen生成的页面(404)。 其在Github存储库中的路径为 https://github.com/AubinMahe/AubinMahe.github.io/blob/master/doxygen/html/dd/dfb/_shareable_8h.html 单击此处查看 从 dcrud文档站点的根目录浏览的同一页面是 http://aubinmahe
..
一个堆栈溢出线程(当然是通过google找到的)指示我使用doxygen自动创建文档(最初是因为我继承了要绘制图表的代码库,而我厌倦了通过Dia Diagram手动完成该过程) 现在doxygen确实非常有用。但是,我似乎仍然无法做到一件事:为整个代码库生成一个包含(或调用)图。它将为单个文件生成一个包含层次结构,或者为单个函数生成一个调用图,但是我想看完整件事(这不是一个很大的代码库:D。
..
我当前的项目是C ++应用程序。该文档是用doxygen生成的,并且注释的格式也相应。 该项目还包括几个带有注释的xml资源文件。我想将它们包括在文档中。 这是我想做的事情的图示: 输入(应用程序使用的文件) ,myFile.xml): < ;!- @类$ Class $在启动$ b时由类MyClass使用的简要设置$ b @image html screenshot
..
我想在Doxygen输出中插入一个数字(或其他,我不太挑剔)脚注。 特殊命令列表不包含任何我可以确定为启用了此功能。我希望有这样的东西: 这是我的文字。\脚注{这是我的脚注} 将产生 是我的文字。 1 然后 1:这是我的脚注 页面底部的 。有没有办法做到这一点或功能上等效的东西? 解决方案 您可以
..
我想使用\copydoc标记重用示例代码块。 解释问题。假设我有两个已记录的函数: / **获取资源。 * / 资源* AquireResource(int id); / **释放资源。* / void ReleaseResource(Resource * res); 在很多情况下,我想举一个如何在上下文中使用该函数的小代码示例,通常涉及到使用同一代码
..
我正在尝试使用Doxygen记录python类。该类通过d-bus公开了一组属性,但是python类中没有相应的公共getter / setter。相反,它们是通过d-bus属性界面(Set / Get / GetAll / Introspect)实现的。 我要做的是能够记录这些属性使用类似这样的东西: ## @property package :: Class ::名称描述 整
..
我最近从Doxygen 1.8.4和GraphViz 2.36升级,在那里我可以轻松地生成图形到Doxygen 1.8.7和GraphViz 2.38,现在无法获取图形。 在构建期间,我收到大量错误,形式为 错误:运行点的问题:退出代码= -1,命令='dot 'JEFTMENTS =“ myfile.dot” -Tpng -O“ myfile.png” 我已降级为GraphVi
..
我正在使用Doxygen为我正在从事的C#项目生成一些API文档。我在此项目中有很多“内部”功能,并且不希望Doxygen在其生成的html中生成这些签名。 我曾尝试启用HIDE_FRIEND_COMPOUNDS,但是 有人知道怎么做吗? 解决方案 附加到Mac H的答案上,您必须设置以下其他配置参数才能使其正常工作: #PREDEFINED标记可用于指定在启动预处理程序
..
我正在寻找一种抑制关于未记录的成员函数的doxygen警告的方法,但不使用 //! @cond 和 //! @endcond ,因此成员函数仍出现在类的提要中。像这样的东西: class Foo { public: Foo(); Foo(const Foo&); Foo&运算符=(const Foo&); }; 这些成员函数做的很明显,不需要文档,但我仍
..