-
8 votesanswersviews
Doxygen：使用C和VHDL进行项目的无缝文档
我正在 Build 一个关于某种库的文档，它包含一个C / C部分和一个VHDL部分，以及一些有指导性的doxygen页面 . 他们必须被置于一个独立的群体中 . 到目前为止，一切都很有效，漂亮而蓬松...... 但是，如果我想通过使用 OPTIMIZE_OUTPUT_VHDL = YES 来优化vhdl子目录中的输出并同时使用 OPTIMIZE_OUTPUT_C = YES 来优化c子目录的输出... -
44 votesanswersviews
如何使用doxygen记录C模板和模板元函数？
是否有关于如何使用Doxygen记录C模板和模板元函数的指南？ 例如： /// @brief metafunction for generation of a map of message types to /// their associated callbacks. /// @tparam Seq the list of message types template< class Seq... -
1 votesanswersviews
使用doxygen和CAPL（CANoe）
我目前正在使用CAPL（CANoe）并且想知道，如果有办法使用doxygen来记录我的CAPL代码 . 我之前使用过doxygen，在一个使用C的项目中，对它非常满意 . 我发现了一些非常有希望的东西（https://github.com/BretislavRychta/CAPL-filter-for-Doxygen），但不幸的是我无法让它发挥作用 . 如果有人可以告诉我如何使它工作，或者给我一个... -
109 votesanswersviews
C项目组织（与gtest，cmake和doxygen）
我是一般编程的新手，所以我决定先从C中创建一个简单的矢量类 . 但是我想从一开始就养成良好的习惯，而不是稍后尝试修改我的工作流程 . 我目前只有两个文件 vector3.hpp 和 vector3.cpp . 随着我对一切事物越来越熟悉，这个项目将慢慢开始增长（使其更像是一般的线性代数库），因此我希望采用"standard"项目布局，以便以后更轻松 . 所以在环顾四周后，我发... -
23 votesanswersviews
doxygen是（事实上的）标准文档语法规范吗？ [关闭]
我们都有记录代码的好习惯，对吧？ 如今，代码内文档本身就有一种语法 . 它几乎就像一种编程语言 . 问题是： 存在多少（多少）文档语法规范？ 是否有标准的文档语法？ 谁在定义这个标准？是否有正式的委员会或机构（就像有一个定义C标准的那样）？ 或"doxygen"成为事实上的标准？ 很难不听说doxygen . 在我参与的每个开源软件项目中都提到过 . 但是，... -
74 votesanswersviews
Objective-C文档生成器：HeaderDoc与Doxygen对比AppleDoc
我需要为我的工作场所实施文档生成解决方案，并将其缩小到 Headers 中提到的三个 . 我已经能够找到这些解决方案之间形式化比较的非常少的信息，我希望那些在上述一个或多个方面有经验的人可以权衡： 以下是我从初次传球中收集到的内容： HeaderDoc优点：与苹果现有的文档一致，与制作苹果文档集的兼容性HeaderDoc缺点：难以修改行为，项目没有积极处理，许多人已经离开它（意味着必须有一些不足之... -
2 votesanswersviews
Doxygen自定义元素和列表
What I want to achieve: 我想在Doxygen生成的文档中列出某些内容（想想 todo ，在我的例子中，它们是任意的 Summons ） . 我想使用自定义项目（ \summon ），因此我可以列出文件中记录的所有 Summons 列表，并生成一个页面，列出整个系统中的所有项目，按文件拆分 . （我只关心在这里生成HTML文档，而不是乳胶 . ） 这是一个例子： 在Foo.c... -
1 votesanswersviews
doxygen - 成员（/// <）之后的文档不起作用
部屋， 我正在尝试用doxygen记录我的C代码，但是使用“成员之后的文档”样式似乎对我不起作用 . doxygen文档说： 在成员之后放置文档如果要记录文件，结构，联合，类或枚举的成员，有时需要将文档块放在成员之后而不是之前 . 为此，您必须在注释块中添加一个<标记 . 请注意，这也适用于函数的参数 . 以下是一些例子：[...]大多数情况下，人们只想在会员后面做一个简短的描述 . 这... -
91 votesanswersviews
在同一个包装上使用roxygen2和doxygen？ [关闭]
我有一个使用 roxygen2 的 R 包 . 它在 /src 中有一些 C 代码，我刚刚开始使用Doxygen . 有没有办法组合文档，或集成编译与roxygen2？任何"best practices"用于放置 C 代码文档的位置？ 谷歌搜索roxygen2和doxygen主要导致 roxygen is similar to doxygen 结果 . 我找到了一些包含Doxy... -
1 votesanswersviews
Doxygen EXTRACT_ALL = NO不起作用
我在C项目中使用doxygen有以下问题 . 我有许多未记录的内部结构 . 因此它在我的Doxyfile中设置 EXTRACT_ALL=NO . 不幸的是，doxygen仍然会提取其中一些 . 这是一个最小的工作示例 . 假设以下头文件： #ifndef HASHTABLE_H # define HASHTABLE_H #ifdef __cplusplus extern "C"... -
0 votesanswersviews
在文件中重复的行的开头处的Doxygen替换元素
我正在尝试使用doxygen生成一个类似于makefile的不支持格式的文档 . 我的行看起来像这样： 001: $(SOME_DYNAMIC_TARGET): some_function 002: 003:///Documentation for Doxygen 004:/// 005:/// 006:fixed_target: $(REDIRECTION_TO_OTHER_TARGET) 我... -
1 votesanswersviews
Doxygen：成员my_function的参数未被（全部）记录
我有这个 C 文件： /** * Blah blah blah. * * @file myfile.c * @author Carlos Alexandro Becker (author@mail.com) * * @brief Some Brief. */ #include <jni.h> #include <stdio.h> #include &qu... -
0 votesanswersviews
.wt文件中的doxygen和模板问题
我已经开始使用Doxygen（预编译1.8.14）为Windows 10上的C项目生成简单的代码文档 . 在头文件中，我定义了三个模板化函数，我的定义放在头文件末尾包含的.tpp文件中 . 看看生成的输出，似乎doxygen不读取此文件 . 因此我总结说doxygen不支持这一点 . 但是根据手册（http://www.doxygen.nl/manual/starting.html）它说&quo... -
9 votesanswersviews
使用doxygen记录Python包
http://www.stack.nl/~dimitri/doxygen/docblocks.html在http://www.stack.nl/~dimitri/doxygen/docblocks.html中给出了使用Python的doxygen使用示例 . 在doxygen生成的相应HTML文档中（Web中的示例输出），如果单击包名称，则会显示与包关联的所有描述，类和函数 . 如果我从doxyg...