2012-02-28 30 views
14

最近我開始在現有的項目中編寫一些doxygen文檔,其中已經有相當多的doxygen評論。只在選定的文件/模塊上運行Doxygen?

由於我學習了一點 - 我喜歡重複編輯和生成文檔,因爲文檔生成速度很慢 - 3-5分鐘。這變得不可行。

我通過刪除源代碼樹中的大部分文件進行管理,因此doxy只能找到我正在編輯的文件,但這確實是一個可怕的解決方案,而不是我想要經常執行的操作。

有沒有一種方法(例如命令行arg或env變量) - 限制哪些文件/模塊用於生成文檔 - 這樣重建文檔可以更快地完成?

+1

您可以將一個文件作爲參數傳遞給doxygen配置文件中的'INPUT'。另請參閱線程中的答案http://stackoverflow.com/questions/203172/how-to-get-doxygen-to-run-faster – Chris 2012-02-28 15:43:33

回答

15

是的,您可以通過命令行或環境變量自定義Doxygen的行爲。例如,如果您只想包括一個文件(include/somefile.h),你可以執行Doxygen的,如:

(cat Doxyfile ; echo "INPUT=include/somefile.h") | doxygen - 

看到Doxygen FAQ的‘我可以通過命令行配置的doxygen?’有關從命令行自定義行爲的更多詳細信息。

另外,如果你想使用環境變量,您可以使用指定類似在配置文件中的以下內容:

INPUT = $(FILE) 

的Doxygen它的配置文件進行環境變量替換,使您可以指定哪些文件(s)應該使用:

export FILE=include/somefile.h 
doxygen Doxyfile 

有關在配置文件中使用環境變量的詳細信息,請參閱Doxygen Configuration