doxygen无法在c++中生成外部api
Doxygen是一个用于生成软件文档的工具，它支持多种编程语言，包括C++。通过分析源代码中的注释，Doxygen可以自动生成代码的文档，包括类、函数、变量等的说明。
然而，Doxygen在生成C++代码的外部API文档时可能会遇到一些问题。这可能是由于以下原因导致的：
- 缺少适当的注释：Doxygen需要通过注释来识别代码中的API元素，并生成相应的文档。如果代码中缺少必要的注释，Doxygen将无法正确生成外部API文档。
- 错误的注释格式：Doxygen对注释有一定的格式要求，例如使用特定的标记来标识函数的参数、返回值等。如果注释格式不正确，Doxygen可能无法正确解析注释并生成相应的文档。
解决这个问题的方法有以下几种：
- 确保代码中有适当的注释：为了让Doxygen正确生成外部API文档，需要在代码中添加适当的注释。注释应该包括对类、函数、变量等的说明，以及它们的参数、返回值等信息。
- 使用正确的注释格式：了解并使用Doxygen支持的注释格式，以确保注释能够被正确解析。可以参考Doxygen的官方文档或者示例代码来了解正确的注释格式。
- 配置Doxygen：在Doxygen的配置文件中，可以设置一些选项来控制文档生成的行为。可以检查配置文件中与C++相关的选项，确保它们被正确设置。
总结起来，要在C++中使用Doxygen生成外部API文档，需要确保代码中有适当的注释，并使用正确的注释格式。此外，还可以通过配置Doxygen来进一步控制文档生成的行为。
腾讯云相关产品和产品介绍链接地址：
- 腾讯云文档中心：https://cloud.tencent.com/document/product
- 腾讯云API网关：https://cloud.tencent.com/product/apigateway
- 腾讯云函数计算：https://cloud.tencent.com/product/scf
- 腾讯云容器服务：https://cloud.tencent.com/product/ccs
- 腾讯云数据库：https://cloud.tencent.com/product/cdb
- 腾讯云对象存储：https://cloud.tencent.com/product/cos
- 腾讯云人工智能：https://cloud.tencent.com/product/ai
相关·内容
2回答
doxygen无法在c++中生成外部api
c、doxygen
我想在一个头文件中记录一个外部API，如下所示#ifdef __cplusplus#endif
* \memberof bar#define JUNK_B DONT_DOC_IT
}函数foo()被定义在存档文件中的某个地方，而"bar.h“被公开
浏览 1提问于2016-09-07得票数 0
1回答
如何从Visual 2015生成的XML创建可读的C++/CX文档
visual-studio、visual-c++、documentation
我的项目是在VS2015上用C++/CX编写的，我正在寻找一种生成API文档的方法。在谷歌搜索和堆栈溢出之后，我尝试了doxygen、VSDocman、NDoc、Atomineer文档和SandCastle，我发现这些工具不支持C++/CX语法，因此它们无法生成正确的文档。我还试图生成VS支持的XML文件。但是很难读取XML文件。
如何从C++/CX生成</em
浏览 1提问于2015-10-08得票数 0
回答已采纳
1回答
doxygen外部变量索引
c++、c、doxygen
我刚开始使用doxygen，可能对所有可用的设置都不熟悉。我查看了配置文件中的所有标签和选项，但没有找到任何与操作相关的标签。编辑:据我目前所见，doxygen根本不理解外部事物。它在html文件中为这些变量或函数生成对随机(第一次看到)位置的
浏览 0提问于2012-06-27得票数 2
回答已采纳
4回答
从doxygen生成的html中删除作者和日期
doxygen
我有使用doxygen样式注释进行注释的C++代码。我们使用下面的模板。根据文档的使用(内部和外部)，我们希望删除生成的html中的作者和日期。是否有从自动生成的html中删除作者和日期的选项？谢谢!* \file Document.h*
* \author John.Doe
浏览 2提问于2017-03-26得票数 0
2回答
如何在doxygen中将API标记为已删除
c++、doxygen、document、semantic-versioning
我使用doxygen生成C++项目文档。我想删除一些冗余的API，我希望将这些API保存在头文件和文档中，删除thei实现和--如何使用doxygen命令将这些API标记为已删除？
浏览 4提问于2021-09-24得票数 0
1回答
我可以在生成的XML (或创建自定义实体)中保留别名的跟踪吗？
xml、doxygen
我已经使用Doxygen记录了C++文件。本文档中的某些行对我有特殊的意义。这些代码行需要由外部工具处理以执行一些checks.To。然后，此工具解析C++文件以提取这些行。现在，我需要改进这个工具，以便进行更多的检查(不仅仅是在标记的行上)。因此，我将不使用C++文件，而是直接处理由Doxygen生成的XML文件。不幸的是，生成的XML文件(至少使用基本配置)不会跟踪我的别名。</nout>
浏览 0提问于2013-06-05得票数 0
5回答
Visual和DoxyGen一起用于文档，还是我们应该使用其他的东西？
c#、visual-studio、documentation
我们目前正在使用DoxyGen编写用C/C++、PHP和Java编写的代码。为了有一个一致的环境，最好也在C#文档中使用它。然而，我们想知道：
其他文档系
浏览 17提问于2010-01-08得票数 56
回答已采纳
4回答
Doxygen:隐藏私有/受保护的method...and提示
c#、documentation、doxygen
我正在使用Doxygen为我们的应用编程接口生成文档，用C#编写。但是，它公开了私有/受保护的成员。有没有办法把它们藏起来？我想出了如何隐藏文件: EXCLUDE =文件名列表在18世纪，当我通过C++在C#中使用Doxygen时，我感觉有点左倾。
浏览 18提问于2009-02-18得票数 15
回答已采纳
1回答
不读取用宏保护的代码
doxygen
我使用doxygen为我们的C++ API生成html帮助。Experimental1 ...#endif
class Experimental2 ...#endif预定义= EXPERIMENTAL_FEATURE1 EXPERIMENTAL_FEATURE2预定义
浏览 0提问于2013-06-18得票数 4
1回答
如何更改doxygen API网页中显示的包含文件路径？
doxygen
我在我的C++项目文档中使用了doxygen。项目的版本相关接口是version.hpp，它是通过cmake的configure_file命令从version.hpp.in生成的。因此，version.hpp位于@CMAKE_BINARY_DIR而不是CMAKE_SOURCE_DIR中。问题来了:我记录了version.hpp.in，从version.hpp生成的doxygen页面，但我想将API的包含路径标记为${CMAKE_SOURCE_DIR}
浏览 28提问于2021-08-23得票数 0
回答已采纳
2回答
为包装C#的C++生成doxygen注释
c#、c++、doxygen、swig
我有一个用C++编写的项目，在该项目中，我还使用swig生成一些C#包装器。C++代码使用Doxygen注释来注释类和函数。能让Swig接受这些doxygen注释并为C#包装类和函数生成doxygen注释吗？
浏览 9提问于2016-06-13得票数 6
4回答
doxygen和graphviz不会生成地图文件
uml、doxygen、graphviz、dot
我正在尝试在一个相当大的C++库上使用Graphviz和doxygen来生成统一建模语言。它会生成.dot文件，但随后又显示无法打开.map文件。我运行的是在64位Windows 7上通过msi安装的doxygen 1.8.3和2.30.1。我还手动设置了Graphviz bin文件夹的路径。错误如下:错误:打开要包含在文档中的地图文件/inherit_graph_11.map时出现问题！
浏览 1提问于2013-07-30得票数 14
2回答
无法生成函数定义的文档，后跟一些宏#定义
c++、documentation、doxygen
我有一个.cpp文件，发现found无法记录包含以下格式的函数：//! \brief Test
//!
浏览 1提问于2009-06-10得票数 1
2回答
Eclipse自动生成Doxygen注释配置
c++、eclipse、doxygen
现在看来Eclipse在某种程度上已经有了对Doxygen的支持。转到C/C++ ->编辑器-> Documentation Tool注释: Doxygen。然而，它似乎只作用于自动生成的/** */ comments。似乎没有办法在Eclipse中配置Doxygen注释生成<
浏览 3提问于2012-06-21得票数 4
回答已采纳
1回答
用于过程性程序的Doxygen
documentation、doxygen、procedural
Doxygen是一个很棒的产品，但它似乎非常面向记录OOP代码。有没有人有任何关于如何以自然的方式使用doxygen来记录程序性工作的提示？
浏览 2提问于2010-07-19得票数 2
回答已采纳
5回答
如何使用Doxygen为Python代码编写文档
python、documentation、python-sphinx、doxygen、docstring
我喜欢Doxygen来创建C或PHP代码的文档。我有一个即将到来的Python项目，我想我记得Python没有/* .. */注释，而且还有自己的自我文档工具，这似乎是Python的文档编制方式。既然我熟悉Doxygen，那么我如何使用它来生成我的Python文档呢？有什么特别需要我注意的吗？
浏览 0提问于2008-09-12得票数 99
回答已采纳
3回答
找不到任何有关MySQL c++连接器应用编程接口的联机文档
c++、mysql
我开始研究mysql c++连接器API。但是我找不到任何关于API的在线文档，我只能找到示例。是否有任何链接(或使用doxygen的隐藏方式)来生成文档？
浏览 2提问于2011-03-15得票数 16
回答已采纳
3回答
将C++源代码反向转换为UML类图
c++、reverse-engineering、class-diagram
我想用MacOS生成一个类图的C++程序。你能建议一个更简单的解决方案吗？
浏览 2提问于2012-10-03得票数 1
3回答
用git管理的项目的Doxygen？
c++、iphone、git、doxygen
我正在做一个C++和Objective C iPhone项目。我使用git作为我的版本控制系统。1)在项目文件夹中创建doxygen HTML文档，并使其成为项目的“一部分”，以便它也被版本化并提交到git。2)在项目文件夹中创建doxygen HTML文档，并将其添加到.gitignore中，以便项目的每个用户都负责生成文档，
浏览 0提问于2010-08-20得票数 15
回答已采纳
2回答
我正在尝试从c++代码生成uml图。在更改了下面的EXTRACT_ALL = YES HAVE_DOT = YES UML_LOOK = YES行之后，我得到了这个错误消息‘
有人知道怎么解决这个问题吗。我在OSX 10.10上使用<em
浏览 2提问于2016-02-03得票数 2
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
实时音视频
即时通信 IM
对象存储活动推荐
腾讯云开发者
