doxygen 学习速记

doxygen

Basic config for a c/c++ project

Generate original config file

doxygen -g

Config details

Changed by

• Best way is use doxywizard.
• or just edit it.

Basic details

• Source code directory

INPUT =

• Project Name

  also you can define project icon , project description and so on .

PROJECT_NAME = GatewayDev

• Out directory

OUTPUT_DIRECTORY = ./doc

• Scan recursively

  if you don’t want write a config file for each directory .

RECURSIVE = YES

• Get all entities instead of only documented entities

EXTRACT_ALL = YES

• Let it suppert c++

OPTIMIZE_OUTPUT_FOR_C = NO

• File pattern

  • FILE_PATTERNS for files I need
  • EXCLUDE_PATTERNS for files I don’t need

• Draw class graph

CLASS_GRAPH = YES
HAVE_DOT = YES

Command source code

Basic command

• put you command before code .
• command use //! ( or /// or //* … )
  *first line of commands id brief .
  
  • then details , if has .

extra