首页 > 解决方案 > 如何在没有源代码的情况下编写裸 doxygen?

问题描述

我将为一些脚本 API 绑定(实际上是 Lua)编写文档,所以根本没有源代码。我怎样才能做到这一点?

我试图像这样写裸露的 doxygen:

\page My API document

\class BindedClassA
\brief descriptions on it

\var member1
\brief ssssssss

\fn bindedMethod1(arg1, arg2)
\brief xxxxxxx
\param arg1 yyyyyyy
\param arg2 zzzzzzz
\return wwwwww

它根本行不通。实际上,您似乎必须通过 . 为每个 doxygen 输入文件指定一种语言EXTENSION_MAPPING

然后我试图把东西放在一个没有源代码但只有注释的假 C++ 文件中:

/**
 *\page My API document
 **/

/**
 *\class BindedClassA
 *\brief descriptions on it
 **/

/**
 *\var member1
 *\brief ssssssss
 **/

/**
 *\fn bindedMethod1(arg1, arg2)
 *\brief xxxxxxx
 *\param arg1 yyyyyyy
 *\param arg2 zzzzzzz
 *\return wwwwww
 **/

它为 BindedClassA 生成文档,但只有简要说明,没有生成任何成员或方法文档。

似乎源代码中的结构对于 Doxygen 正常工作起着至关重要的作用,但我根本没有源代码。

标签: doxygen

解决方案


推荐阅读