doxygen

(Updated: )
(1 min to read)

doxygen -s -g # 生成默认配置文件 Doxyfile

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
@file
@author
@brief
@param[in/out]
@return
@retval
@details
@see
@note
@warning

多行注释：
/**
 * 
 */

单行注释：
/** */

与代码同在一行的注释:
/**< */

doxygen Doxyfile生成文档

Doxyfile中有用的设置

  • OUTPUT_DIRECTORY
  • OUTPUT_LANGUAGE
  • EXTRACT_ALL
  • HAVE_DOT
  • CALL_GRAPH
  • RECURSIVE
  • INPUT
  • EXCLUDE
  • EXCLUDE_PATTERNS = */doc/* \
  • */benchmarks/*