如何创建仅在Doxygen中记录"公共"API的文件
在Doxygen中创建仅记录"公共"API的文件，可以按照以下步骤进行操作：
- 创建一个新的源代码文件，命名为"public_api.h"（可以根据实际情况命名）。
- 在该文件中，只包含公共API的声明和文档注释，不包含具体的实现代码。
- 使用适当的注释格式，例如Doxygen支持的Javadoc风格或者C++风格的注释。
- 在每个公共API的声明前，使用适当的注释标记，例如
@brief表示简要说明，@param表示参数说明，@return表示返回值说明等。 - 在注释中提供API的详细说明，包括功能、用法、参数说明、返回值说明等。
- 根据需要，可以使用Doxygen提供的其他标记和指令来进一步定制文档生成的格式和内容。
- 在Doxygen配置文件中，将"public_api.h"文件添加到输入文件列表中，以确保Doxygen会处理该文件并生成相应的文档。
- 运行Doxygen，生成文档。
通过以上步骤，你可以在Doxygen中创建一个仅记录"公共"API的文件，并生成相应的文档。这样做的好处是可以将API的文档与具体的实现代码分离，使得文档更加清晰、易读，并且方便维护和更新。
腾讯云相关产品推荐：无
相关·内容
1回答
DO2 1.8.10/*! This is a test class class TestClass {
*/ 当我为上述类生成doxygen没有创建名为classInnerTestClass.html的内部类文档文件。在
浏览 2提问于2015-09-10得票数 0
回答已采纳
我正在使用Doxygen和一些内嵌的C源代码。给定一个.c/.h文件对，您是在函数原型(.h文件)上还是在函数定义(.c文件)上放置Doxygen注释，还是在这两个位置都复制它们？我遇到了一个问题，当我在一个地方而不是另一个地方记录文档时，Doxygen会警告我遗漏了注释；这是意料之中的吗，还是我的Doxygen搞砸了？
浏览 9提问于2009-08-13得票数 26
我在网上找到了一个示例cmake文件，并将其放在我的项目的DOOX子目录中，myproject.doxgen文件也位于这个子目录中，其中包含/doc配置。我已经测试过，运行doxygen.exe myproject.doxygen会产生有效的输出。我只需要将它构建到CMake过程中。based API
documentation (requires Doxygen)&quo
浏览 0提问于2016-01-19得票数 17
回答已采纳
习惯上在哪里编写类和方法的代码内文档？对于这样的事情，有没有一个广受推崇的惯例？大多数C++项目是以一种方式而不是另一种方式来完成的吗？
或者文档应该写在两面(即在.hpp和.cpp文件中)，可能一边是简短的描述，另一面是较长的描述？最重要<em
浏览 0提问于2010-08-26得票数 35
回答已采纳
我是Doxygen的新手，我正在尝试记录一个我计划开源的API。我真的很想构建两套文档，一套适用于API的最终用户，另一套适用于打算修改它的用户。有没有一种方法可以标记Doxygen注释块，这样我就可以生成"user“和"dev”文档树？我的问题有没有更好的解决方案？谢谢!
浏览 4提问于2011-08-04得票数 3
回答已采纳
程序的树形结构如下： |---- lib1 |----include |----src |---- app1 |---- app2App1和app2是使用lib1和lib2的两个应用程序我已经在lib1和lib2中记录了头文件。然而，我也想记录app1和app2，因为
浏览 0提问于2017-09-19得票数 0
我正在尝试记录一个C API，它包含在一个单独的C头文件中。当我在文件上运行doxygen时，它给出了当前没有文档记录的C宏的错误，但是当我为宏添加必要的文档时，尽管没有文档记录的错误被清除，宏和文档不会出现在doxygen生成的html输出中。只有一小部分文档头文件，即结构，实际上出现在任何
浏览 3提问于2013-09-07得票数 6
如果您正在开发和文档库..您是记录每个源文件中的每个函数/数据结构，还是只记录出现在公共头文件中的公共函数/数据结构？？
我倾向于第二种选择，这样可以吗？
浏览 0提问于2011-09-15得票数 0
回答已采纳
3回答
我从C#创建了java api -ported，更具体地说，它除了公共接口之外，还包含了许多我不想让用户知道的内部内容。在C#中，我使用了doxygen来生成文档。我假设javadoc具有类似的功能，可以排除某些公共成员、类，甚至包。谢谢
浏览 1提问于2009-02-26得票数 1
回答已采纳
2回答
我正在为我的C++项目使用Doxygen，该项目将托管在github中。到目前为止，我还没有找到一种生成markdown文件的方法。我<
浏览 0提问于2012-10-26得票数 4
我正在使用Doxygen (Doxywizard，GUI)来记录一个PHP项目。Doxygen没有记录我的非类文件。这就是为我生成的 goes向导
浏览 0提问于2011-08-28得票数 4
回答已采纳
在我的源代码中，我经常得到具有相同参数的函数。因此，此参数的说明也是相同的。我知道我可以使用\copybrief、\copydoc或\copydetails复制文档，但它们是否也可以复制单个参数的描述？或者，有没有办法只在代码中的某个地方管理这个参数的描述？感谢你对m0nKeY的帮助
浏览 1提问于2015-09-23得票数 4
我目前在c文件中有几个#define，它们为硬件测试关闭了一些功能。但是，当它们还未定义时，我想用doxygen来记录它们。#define SIMULATE_SOME_HW_INTERFACE如何强制dox
浏览 2提问于2010-08-25得票数 3
回答已采纳
我正在使用boost::python在c++代码中添加一个python模块。c++项目是用doxygen记录的。我想为python模块创建一个文档，但我不知道如何避免这样的冗余：using namespace boost::python;
/** @briefn\n:param a: an integer\n:param b: another integer\n:returns:
浏览 5提问于2016-01-20得票数 4
回答已采纳
1回答
.Net程序集的文档报告
、、、
我正在使用沙堡为我的API生成文档，但是在我为其生成chm的程序集中有许多未记录的源代码，有没有办法获得未记录类型的列表(或那些缺少成员文档的类型)？
浏览 1提问于2011-08-07得票数 1
回答已采纳
2回答
好的，我知道有PhpDocumentor可以从php代码中生成文档。它似乎已经很长时间没有更新了(但也许他们认为它的大部分功能都是完整的)。虽然这对于记录其他程序员的事情可能很好，但它似乎不太适合记录web服务的外部"API“。也就是说，如果我有一个很好的MVC结构化项目，PhpDocumentor可能非常适合为项目中的其他开发人员记录所有的模型和内部库等，但是我如何<e
浏览 1提问于2010-01-22得票数 2
如何配置DoxyGen以记录ActionScript文件？
我已经在doxygen的搜索模式中包含了*.as和*.asi文件，但其中没有显示类、函数和变量。
浏览 0提问于2008-09-24得票数 11
回答已采纳
我有一个我正在扩展的框架。有一些源文件夹包含了相当多的文件，我想使用doxygen来记录我的工作(特别是那些来自我的文件)。我记录的任何文件都是头文件： * @file my_file.c我能告诉doxygen不要包含没有这样一个头的文件</e
浏览 5提问于2014-06-02得票数 1
回答已采纳
5回答
C/C++头文件文档
、、、
您认为在C++中创建公共头文件时的最佳实践是什么？
头文件应该不包含文档、简短文档还是大量文档？我见过从几乎没有文档(依赖于一些外部文档)到大规格的不变量、有效参数、返回值等等。我不确定我到底喜欢什么，大的文档很好，因为你总是可以从你的编辑器中访问它，另一方面，一个包含非常简短的文档的头文件通常可以在一到两页的文本中显示完整<e
浏览 75提问于2009-01-28得票数 19
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
实时音视频
即时通信 IM活动推荐
腾讯云开发者
