C++ Docs with Doxygen ๐
Doxyfile ์ค์ ์ ํตํ C++ ํ๋ก์ ํธ ๋ฌธ์ํ ๊ฐ์ด๋
DoxygenC++๋ฌธ์ํDoxyfile์ค์
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
: ์์ฑ๋์ง ์์.