Tag: doxygen

如何使用doxygen从C ++源码创buildUML类图

我一直在寻找一些材料来描述如何用doxygen生成简单的类图，但是找不到一个。 任何人都可以帮忙吗？ 我需要从一组C ++文件创build如下所示的图表。 如果有更好的工具来实现这一点，请让我知道。

Objective-C文档生成器：HeaderDoc与Doxygen vs. AppleDoc

我需要为我的工作场所实施文档生成解决scheme，并缩小到标题中提到的三个解决scheme。 在这些解决scheme之间的forms化比较中，我能够find很less的信息，我希望那些有上述经验的人能够衡量： 这是我从最初的传球中能够收集到的东西： HeaderDoc优点：与苹果现有的文档一致，与制作苹果docset的兼容性 HeaderDoc缺点：很难修改行为，项目并没有积极的工作，很多人已经离开了它（这意味着一定有什么不足，尽pipe我无法量化）。 Doxygen优点：积极支持社区B / C广泛的使用基地，非常可定制的，多数输出types（如乳胶等） Doxygen缺点：使其看起来/行为与苹果文档一致，与苹果docsets的兼容性不是那么简单 AppleDoc优点：看起来与苹果现有的文档一致，与制作苹果docsets的兼容性， AppleDoc缺点：正在积极开发typedefs，枚举和函数的文档 这听起来准确吗？ 我们期望的解决scheme将有： 一致的外观和感觉与苹果objective-c类参考 能够select单击从Xcode中提取文档参考，然后链接到文档（就像苹果的类） 智能处理类别，扩展名等（甚至是苹果类的自定义类别） 能够创build我们自己的参考页面（就像这个页面：加载…可以包括图像，并可以从生成的类引用无缝链接，如苹果的UIViewController类引用链接到链接的页面。 易于运行可集成到构build脚本中的命令行命令 优美的处理非常大的代码库 基于以上所有的信息，上面的解决scheme是否明显比其他解决scheme好？ 任何build议或信息添加将非常感激。

如何与Doxygen做一个介绍页面

我使用Doxygen为我的SDK制作了文档。 它包含文件，命名空间，类，types等的列表 – 我把所有的东西放在代码中作为Doxygen注释。 现在我想写一些关于SDK（一种介绍）的一般信息，它不直接与任何代码元素相关。 我想把这个介绍放在文档开始页面上。 我怎样才能做到这一点？

build议一个好的Doxygen样式表

我正在使用Doxygen从我的代码生成HTML文档。 不过，我发现默认的样式表有相当差的字体和布局的select。 我知道我可以写我自己的CSS文件来得到我想要的输出，但在我花时间在这之前，我想知道是否有任何像样的自定义样式表已经可用。

何处放置内部库的doxygen注释块 – 在H中还是在CPP文件中？

常识告诉Doxygen注释块必须放在类，结构体，枚举，函数，声明所在的头文件中。 我同意，这是一个很好的参数，意思是没有它的源代码的分发（只有头文件和库和目标代码）。 但是…当我正在开发公司内部（或作为自己的一个项目）库时，我一直在考虑完全相反的方法，它将被用于完整的源代码。 我所build议的是在实现文件（HPP，INL，CPP等）中放置大的注释块，以避免混乱头中声明的类和函数的接口。 优点： 在头文件中更less的混乱，只能添加function的分类。 例如使用Intellisense时预览的注释块不会发生冲突 – 这是我在.H文件中为函数注释块时观察到的缺陷，并且其内联定义位于相同的.H文件中但是包含在.INL文件中。 缺点： （显而易见的）注释块不在声明的头文件中。 那么，你觉得和可能build议什么？

在同一个包上使用roxygen2和doxygen？

我有一个使用roxygen2的R包。 它在/src有一些C代码，我刚刚开始与Doxygen合作。 有什么方法可以合并文档，或者将编译与roxygen2集成吗？ 哪里可以放置C代码文档的任何“最佳实践”？ 谷歌searchroxygen2和doxygen主要导致roxygen是类似于doxygen的结果。 我用Doxyfilesfind了一些软件包，但没有一致的组织。 例如，lme4将inst/doc/Doxyfile输出到lme4源目录之外的名为doxygen的文件夹。 Matrix的根目录中还有一个Doxyfile（但是在以前的版本中是在inst ，这个文档也被导出到软件包目录之外。 是否有任何理由不将C文档包含在软件包中，或者为什么Doxgen在R软件包中很less使用，尽pipe广泛使用C ？ 更新：请参阅相关的roxygen2function请求

C ++项目组织（使用gtest，cmake和doxygen）

我是一般的编程新手，所以我决定从C ++开始创build一个简单的向量类。 不过，我想从一开始就接受良好的习惯，而不是稍后尝试修改我的工作stream程。 我目前只有两个文件vector3.hpp和vector3.cpp 。 随着我越来越熟悉这个项目，这个项目将慢慢地开始增长（使它更像一个一般的线性代数库），所以我想采用一个“标准”的项目布局，以便以后更容易。 所以在环视后我发现了两种组织hpp和cpp文件的方法，第一种是： project └── src ├── vector3.hpp └── vector3.cpp 第二个是： project ├── inc │ └── project │ └── vector3.hpp └── src └── vector3.cpp 你会推荐哪个，为什么？ 其次我想使用谷歌C + +testing框架unit testing我的代码，因为它似乎相当容易使用。 你是否build议把这个与我的代码捆绑在一起，例如在inc/gtest或者contrib/gtest文件夹中？ 如果捆绑，你build议使用fuse_gtest_files.py脚本来减less数量或文件，或保持原样？ 如果没有捆绑，这个依赖关系是如何处理的？ 在编写testing时，这些通常是如何组织的？ 我想每个类都有一个cpp文件（例如test_vector3.cpp ），但都编译成一个二进制文件，以便它们都可以轻松地运行在一起。 因为gtest库通常是用cmake和make构build的，所以我认为我的项目也可以这样构build？ 如果我决定使用下面的项目布局： ├── CMakeLists.txt ├── contrib │ └── gtest │ ├── gtest-all.cc │ └── gtest.h ├── […]

使用doxygen编写代码的最佳技巧？

我的团队开始使用doxygen来logging我们的C代码，特别关注我们的公共API头文件。 在doxygen中似乎有很多的灵活性和不同的特殊命令，这很好，但不清楚什么是好事，什么是坏事，没有反复试验。 什么是你最喜欢的方式来标记你的代码，你必须做什么和不做什么？ 请提供您的重要提示，每个答案以方便投票。 我期望定义我们的整个API文档的方法，包括提供一个模板来让团队的其他成员开始。 到目前为止，我有这样的东西： /** * @file example_action.h * @Author Me (me@example.com) * @date September, 2008 * @brief Brief description of file. * * Detailed description of file. */ /** * @name Example API Actions * @brief Example actions available. * @ingroup example * * This API provides certain actions as an example. […]

Xcode 5有哪些新的文档命令？

Xcode 5的新特性之一就是能够使用特殊的注释语法logging自己的代码。 格式类似于Doxygen，但似乎只支持这些function的一个子集。 哪些命令是支持的，哪些不是？ 他们的用法与Doxygen有什么不同？