Doxygen中的强制函数文档用于记录JavaScript API

时间:2011-01-19 10:56:56

标签: warnings doxygen

我使用Doxygen来记录我的C ++(Qt)项目的JavaScript API。我们的想法是为JavaScript接口编写一个特定的文档,一个用于我们常用的C ++类。 一个例子(datasource.dox)看起来像这样:

\addtogroup JavaScriptAPI
@{
...
\class DataSource
\brief DataSource is the .... some doc goes here ....

\section formats Supported formats
....

\fn isOpen()
\brief returns true if the data source is currently open...
...
@}

生成的帮助看起来不错w.r.t.类描述(或'对象'描述),但缺少函数文档(isOpen(),...)。 Doxygen会创建警告消息,例如: 警告:未声明或定义记录的函数`bool isOpen'。

问题,现在:我可以以某种方式强迫doxygen使用我的\ fn-d函数描述吗?如果doxygen为我创建了所有这些成员索引,那就太好了......

1 个答案:

答案 0 :(得分:0)

此处列出了使用doxygen和Javascript的两种方法http://www.doxygen.org/helpers.html (寻找JavaScript)