2010-08-20 55 views
11

我正在研究C++和Objective C iPhone項目。我使用git作爲我的版本控制系統。用git管理項目的Doxygen?

代碼庫已經增加了很多,所以我想在項目中添加Doxygen。問題是我不確定什麼是最好的方法。

我想過幾個選項:

1)在項目中創建文件夾中的Doxygen的HTML文檔,使該項目的是「部分」,這樣它也和版本致力於飯桶。

2)在項目中創建文件夾中的Doxygen的HTML文檔,並將其添加到.gitignore因此該項目的每個用戶負責生成文檔和項目的Git倉庫將保持不變(除了.gitignore)。

我們在我們的主服務器上使用了一個git -bare存儲庫,所以要在服務器中掛載一個包含HTML Doxygen的網頁會很複雜(你實際上看不到帶有git --bare回購的項目文件,所以我將無法看到Doxygen生成的HTML文檔,除非我單獨上傳)

也許我可以做一些cron-job,以保持在服務器端更新doxygen?

幫助非常歡迎。

回答

18

我認爲不應該將生成的文件存儲在源存儲庫中,特別是當它們是由通常可用的工具(如Doxygen)從已存儲在存儲庫中的文件生成時。在Doxygen的情況下,您只需要在回購中存儲Doxyfile

(或者,更好的,如果你使用autoconf,商店Doxyfile.in,從而使當前的項目版本號被代入生成Doxyfile作爲configure步驟的一部分。)

如果你想確保每個檢查項目的人都會獲得Doxygen生成的參考手冊的副本,使其成爲默認構建過程的一部分。

4

我同意沃倫,但我想補充以下內容:

您可以使用「」後收到鉤「」每有一個推純倉庫時自動更新(獨立)工作目錄。這種方法描述爲在這裏維護受版本控制的網站http://toroid.org/ams/git-website-howto,我以這種方式使用它。

我覺得你可以在更新後添加一個步驟來運行Doxygen,這將是你要找的東西。您可能需要考慮如果Doxygen borks如何向用戶/提交者報告錯誤,但這是我看到的唯一問題。

0

入住僅doxygen的配置文件,

讓你continuous integration服務器建立文檔並將其發佈到內部可用的網站,分享與團隊的URL。