avatar
B๊ธ‰ ์„œ๊ณ 

C++ Docs with Doxygen ๐Ÿ“˜

Doxyfile ์„ค์ •์„ ํ†ตํ•œ C++ ํ”„๋กœ์ ํŠธ ๋ฌธ์„œํ™” ๊ฐ€์ด๋“œ
DoxygenC++๋ฌธ์„œํ™”Doxyfile์„ค์ •
Nov 10
ยท
2 min read

  • os : macOS

# ๋…์‹œ์   ์„ค์น˜
brew install doxygen

# ์„ค์ •ํŒŒ์ผ ์ƒ์„ฑ
doxygen -g Doxyfile 

# ๋…์‹œ์   ๋ฌธ์„œ ์ƒ์„ฑ
doxygen Doxyfile

Doxyfile ์„ค์ •

๋ฌธ์„œ ์ƒ์„ฑํ•˜๊ธฐ ์ „์— Doxyfile ์—์„œ ๋‹ค์Œ๊ณผ ๊ฐ™์ด ์„ค์ •.

PROJECT_NAME = "Example Project"
INPUT = ./example.h
RECURSIVE = NO
OUTPUT_DIRECTORY = ./docs
GENERATE_HTML = YES
  • PROJECT_NAME

    • ์ƒ์„ฑ๋˜๋Š” ๋ฌธ์„œ์˜ ํ”„๋กœ์ ํŠธ ์ด๋ฆ„์„ ์ง€์ •.

  • INPUT

    • ๋ฌธ์„œํ™”ํ•  ํŒŒ์ผ์ด๋‚˜ ํด๋”์˜ ๊ฒฝ๋กœ๋ฅผ ์ง€์ •.

  • RECURSIVE

    • INPUT์œผ๋กœ ์ง€์ •๋œ ํด๋” ๋‚ด์— ์žˆ๋Š” ํŒŒ์ผ์„ ์„œ๋ธŒํด๋”๊นŒ์ง€ ํฌํ•จํ•˜์—ฌ ์žฌ๊ท€์ ์œผ๋กœ ๊ฒ€์ƒ‰ํ• ์ง€ ์—ฌ๋ถ€.

    • NO : INPUT ํด๋”์˜ ์ตœ์ƒ์œ„ ํŒŒ์ผ๋งŒ ๋ฌธ์„œํ™”์— ํฌํ•จ.

    • YES : ์ง€์ •๋œ ํด๋”์˜ ๋ชจ๋“  ํ•˜์œ„ ํด๋”๊นŒ์ง€ ํฌํ•จํ•˜์—ฌ ํŒŒ์ผ์„ ์ฐพ์Œ.

  • OUTPUT_DIRECTORY

    • Doxygen์ด ์ƒ์„ฑํ•œ ๋ฌธ์„œ ํŒŒ์ผ์ด ์ €์žฅ๋  ๊ฒฝ๋กœ.

  • GENERATE_HTML

    • HTML ํ˜•์‹์˜ ๋ฌธ์„œ ์ƒ์„ฑ์„ ํ™œ์„ฑํ™”ํ• ์ง€ ์—ฌ๋ถ€.

    • YES : HTML ๋ฌธ์„œ๊ฐ€ ์ƒ์„ฑ

    • NO : ์ƒ์„ฑ๋˜์ง€ ์•Š์Œ.







ํ”„๋กœ๊ทธ๋ž˜๋ฐ์— ๋Œ€ํ•œ ๊ฒƒ๋“ค์„, ๋ฌด์ž‘์ • ์จ ๋‚ด๋ ค๊ฐ€์š”! ๐ŸŒ€