把幾個重要的細項列出來....
這邊指的是Windows版的GUI的Wizard/Expert tab下面的項目。
不過其他版本應該很容易依樣畫葫蘆。
Wizard- Project
- Scan recursively:讓他搜尋到子目錄
- Mode
- "Select the desired extraction mode:":除非已經做了完整的註解,否則All Entities才能列出足夠的資料
- "Include cross-referenced source code in the output":勾起來則會把原始碼一起文件化並加上link。建議勾選
- Output
- HTML→"with frames and a navigation tree":會在左邊以frame建立索引連結
##ReadMore##
Expert- Project
- CREATE_SUBDIRS:建立複數個目錄。怕同一目錄裡檔案太多的選項
- INLINE_INHERITED_MEMB:將子類別從父類別那邊繼承來的method也列出。不包括constructor、destrcutor跟assignment operators
- STRIP_FROM_PATH:將原本完整列出的檔案位置消去指定的path
- Build
- EXTRACT_PRIVATE:列出private成員
- EXTRACT_STATIC:列出(C/C++)檔案的static內容
- SHOW_DIRECTORIES:列出目錄結構。適合依照目錄分層的project
- Source Browser
- SOURCE_BROWSER:產生頁面詳列Source code。強烈建議。
- INLINE_SOURCES:是否將原本只包含declaration的文件改成顯示完整的definition。注意資料太多反而會模糊焦點。建議不要。
- REFERENCED_BY_RELATION:將用到此成員的method等列出。強烈建議
- REFERENCES_RELATION:將此成員用到的method/variables等列出。強烈建議。
- REFERENCES_LINK_SOURCE:若勾選,則上述兩個項目列出的連結連往Source code頁面,否則連往文件。看個人需求。
- HTML
- GENERATE_TREEVIEW:跟Wizard的"with frames and a navigation tree"同作用
- TREEVIEW_WIDTH:上述TreeView的寬度