c++ - Doxygen 不生成任何文档

标签 c++ doxygen documentation-generation

这是我的 lexer.hpp 文件:

/**
*\文件
*\简要词法分析
*\作者伊戈尔·扎什切尔金
*
* MyLisp 的词法分析 API。
*/

#ifndef LEXER_H
#define LEXER_H

#include <字符串>
#include < vector >

/**
*\brief 用于将 token (Token)与其类型联系起来。
*\日期 2018 年 6 月 29 日
*
* 代币编号 - 12、5.4、-200
* TokenString - “你好,世界”
* TokenBoolean - 真,假
* TokenIdentifier - 函数名、变量名
* TokenSeparator - ( ) ,
*/

枚举 token 类型 {
TokenNumber///\brief 存储数字数据的 token
,TokenString///\brief 存储符号数据的 token ,结束和开始于 "
,TokenBoolean///\brief 只存储一种状态 1 或 0 的 token
,TokenIdentifier///\brief 链接到某物的标记(变量,函数)
,TokenSeparator///\brief 分割代码逻辑部分的标记
};

/**
*\brief Token 的值类型
*\日期 2018 年 6 月 29 日
*
* 简单地说,包装 std::string
*/

typedef std::string TokenValue;

/**
*\brief 词法分析的最小部分
*\日期 2018 年 6 月 29 日
*
* 结构化的 TokenType 和 TokenValue 对(又名 std::string)
*/

类 token {
私有(private)的:
const TokenType 类型;///\brief token 的类型
const TokenValue 值;///\brief Token的值(value)
上市:
Token(TokenType 类型,std::string 值);///\简要构造函数

const TokenType getType();////类型属性的简要Getter
常量 TokenValue getValue();///\值属性的简要Getter
};

/**
*\brief 词法分析 API 实例
*\日期 2018 年 6 月 29 日
*/

类词法分析器{
私有(private)的:
std::string 代码;///\简要源代码
上市:
词法分析器(标准::字符串代码);///\简要构造函数

/**
*\brief 标记源代码
*\日期 2018 年 6 月 29 日
*
* 从代码属性 (std::string) 生成标记序列 (std::vector)
*/

标准:: vector 标记化();
};

#endif//LEXER_H

一切都很好(这是我的想法),但是当我运行 doxygen src/lexer/lexer.hpp
Doxygen 生成空文档。
怎么了?

最佳答案

你应该有一个 doxygen 配置文件(Doxyfile),可以使用 doxygen -g 生成默认版本.在 Doxyfile 中,您可以设置所需的选项。然后你可以用 doxygen 启动 doxygen的 doxygen Doxyfile .

即使使用 OP 使用的设置,我也得到了文档(以及许多警告消息,例如:“警告:忽略第 2 行的未知标签‘文件’,文件 lexer.hpp”,表明某些事情不正确)。

另请参阅 doxygen 文档。

关于c++ - Doxygen 不生成任何文档,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/51114212/

相关文章:

c++ - 无效使用非静态数据成员 C++ Student

c++ - Doxygen 报告 "potential recursive class relation"

pdf - 如何从 Doxygen 获取单个 PDF 文档?

ruby - 使用 Cucumber 或 RSpec+Selenium 创建最终用户文档?

python - 我如何设置 Read the Docs 以便 Sphinx autodoc 选项起作用?

c++ - 为什么函数 cv::subtract() 返回错误 "size of input arguments do not match"?

C++ 具有不同返回类型的相同函数参数

c++ - 为什么 Windows 上的 sys/types.h 中没有定义 S_IRWXG 和 S_IRWXO?

doxygen - 如何在 doxygen 中重新生成类 url?

c# - 在 xml 文档中,我可以插入对方法组的引用吗?如何?