使用 Doxygen 生成源码文档

Doxygen 是一个开源跨平台的，以相似 JavaDoc 风格编写软件参考文檔的工具

Getting started

建立配置文件

doxygen -g <config-file>

运行 doxygen

doxygen <config-file>

Configuration

项目名称

PROJECT_NAME = My Project

项目简介

PROJECT_BRIEF = What a project

项目 Logo

PROJECT_LOGO = src/images/logo.png

主页面

USE_MDFILE_AS_MAINPAGE = README.md

文档的语言

OUTPUT_LANGUAGE = Chinese

指定须要生成文档的文件，以空格分割

INPUT = ./src

排除的文件

EXCLUDE = ./src/Demo

写入文档的路径

OUTPUT_DIRECTORY = ./docs

是否搜索子目录

RECURSIVE = YES

标记指定一个或多个通配符模式

EXCLUDE_PATTERNS = */node_modules/*

即便各个类或函数没有文档，也要提取信息

EXTRACT_ALL = YES

是否记录私有成员

EXTRACT_PRIVATE = YES

是否包含静态成员

EXTRACT_STATIC = YES

生成一个搜索框

SEARCHENGINE = YES

点工具

HAVE_DOT = YES

指定 graphviz 的路径

DOT_PATH

Output Formats

HTML

GENERATE_HTML

HTML 帮助编译器

GENERATE_HTMLHELP

Special Commands

• brief
• details
• param
• return
• note

Showcase

generator-modation 脚手架的源码文档