這是一個生成文檔的工具,可以通過代碼文件中的註釋進行文檔的生成,通過畫圖工具可以繪製調用過程和文件包含關係等。
然後在使用過程中，可能會發現生成文檔無成員變量。
這是因爲doxygen對私有成員未導出，按以下配置即可。
doxygen配置選項含義詳解
| 選項 | 含義 |
|---|---|
| DOXYFILE_ENCODING | Doxygen文件的編碼方式，默認爲UTF-8，若希望支持中文，最好設置爲 GB2312 |
| PROJECT_NAME | Project 的名字，以一個單詞爲主，多個單詞請使用雙引號括住。 |
| PROJECT_VERSION | Project的版本號碼。 |
| OUTPUT_DIRECTORY | 輸出路徑。產生的文件會放在這個路徑之下。如果沒有填這個路徑，將會以目前所在路徑作爲輸出路徑。 |
| OUTPUT_LANGUAGE | 輸出語言, 默認爲English 。 |
| EXTRACT_ALL | 爲NO，只解釋有doxygen格式註釋的代碼；爲YES，解析所有代碼，即使沒有註釋 |
| EXTRACT_PRIVATE | 是否解析類的私有成員 |
| EXTRACT_STATIC | 是否解析靜態項 |
| EXTRACT_LOCAL_CLASSES | 是否解析源文件（cpp文件）中定義的類 |
| INPUT | 指定加載或找尋要處理的程序代碼文件路徑。這邊是一個表列式的型態。並且可指定檔案及路徑。 |
| FILE_PATTERNS | 如果您的INPUT Tag 中指定了目錄。您可以透過這個Tag來要求Doxygen在處理時，只針對特定的檔案進行動作。例如：您希望對目錄下的擴展名爲.c, .cpp及.h的檔案作處理。您可設定FILE_PATTERNS = .c, .cpp, *.h。 |
| RECURSIVE | 這是一個布爾值的Tag，只接受YES或NO。當設定爲YES時，INPUT所指定目錄的所有子目錄都會被處理. |
| EXCLUDE | 如果您有某幾個特定檔案或是目錄，不希望經過Doxygen處理。您可在這個Tag中指定。 |
| EXCLUDE_PATTERNS | 類似於FILE_PATTERNS的用法，只是這個Tag是供EXCLUDE所使用。 |
| SOURCE_BROWSER | 如果設定爲YES，則Doxygen會產生出源文件的列表，以供查閱。 |
| INLINE_SOURCES | 如果設定爲YES ，則函數和類的實現代碼被包含在文檔中 |
| ALPHABETICAL_INDEX | 如果設定爲YES，則一個依照字母排序的列表會加入在產生的文件中。（有很多類、結構等項時建議設爲YES） |
| GENERATE_HTML | 若設定爲YES ，就會產生HTML版本的說明文件。HTML文件是Doxygen預設產生的格式之一。 |
| HTML_OUTPUT | HTML文件的輸出目錄。這是一個相對路徑，所以實際的路徑爲OUTPUT_DIRECTORY加上HTML_OUTPUT。這個設定預設爲html。 |
| GENERATE_HTMLHELP | 是否生成壓縮HTML格式文檔（.chm） |
| HTML_FILE_EXTENSION | HTML文件的擴展名。預設爲.html。 |
| HTML_HEADER | 要使用在每一頁HTML文件中的Header。如果沒有指定，Doxygen會使用自己預設的Header。 |
| HTML_FOOTER | 要使用在每一頁HTML文件中的Footer。如果沒有指定，Doxygen會使用自己預設的Footer。 |
| HTML_STYLESHEET | 您可給定一個CSS 的設定，讓HTML的輸出結果更完美。 |
| GENERATE_HTMLHELP | 如設定爲YES，Doxygen會產生一個索引文件。這個索引文件在您需要製作windows 上的HTML格式的HELP檔案時會用的上。 |
| GENERATE_TREEVIEW | 若設定爲YES，Doxygen會幫您產生一個樹狀結構，在畫面左側。這個樹狀結構是以JavaScript所寫成。所以需要新版的Browser才能正確顯示。 |
| TREEVIEW_WIDTH | 用來設定樹狀結構在畫面上的寬度。 |
| GENERATE_LATEX | 設定爲YES 時，會產生LaTeX 的文件。不過您的系統必需要有安裝LaTeX 的相關工具。 |
| LATEX_OUTPUT | LaTeX文件的輸出目錄，與HTML_OUTPUT用法相同，一樣是指在OUTPUT_DIRECTORY之下的路徑。預設爲latex。 |
| LATEX_CMD_NAME | LaTeX程序的命令名稱及檔案所在。預設爲latex。 |
| GENERATE_RTF | 若設定爲YES ，則會產生RTF 格式的說明檔。 |
| RTF_OUTPUT | 與HTML_OUTPUT 用法相同，用來指定RTF 輸出檔案路徑。預設爲rtf。 |
| GENERATE_MAN | 若設定爲YES ，則會產生Unix Man Page 格式的說明文件。 |
| MAN_OUTPUT | 與HTML_OUTPUT 用法相同，用來指定Man Page的輸出目錄。預設爲man。 |
| GENERATE_XML | 若設定爲YES ，則會產生XML 格式的說明文件。 |
| ENABLE_PREPROCESSING | 若設定爲YES ，則Doxygen 會激活C 的前置處理器來處理原始檔。 |
| PREDEFINED | 可以讓您自行定義一些宏。類似於gcc 中的-D選項。 |
| CLASS_DIAGRAMS | 這個標記用來生成類繼承層次結構圖。要想生成更好的視圖，可以從 Graphviz 下載站點 下載 dot 工具。Doxyfile 中的以下標記用來生成圖表： |
| HAVE_DOT | 如果這個標記設置爲 Yes，doxygen 就使用 dot 工具生成更強大的圖形，比如幫助理解類成員及其數據結構的協作圖。注意，如果這個標記設置爲 Yes， 標記就無效了 |
| CLASS_GRAPH | 如果 標記和這個標記同時設置爲 Yes，就使用 dot 生成繼承層次結構圖 |
| GRAPHICAL_HIERARCHY | 設置爲YES時，將會繪製一個圖形表示的類圖結構 |