我可以使用doxygen來記錄命令行程序嗎？

Question

我貢獻了一個使用Doxygen來記錄一系列C庫的大型代碼項目。我們也開始使用doxygen和doxypy作爲關聯的python模塊。

有沒有簡單的方法來記錄命令行程序（在python或C中）和他們的命令行選項，（自動）使用doxygen？

Answer 1

爲了生成man頁面，您需要將GENERATE_MAN標記設置爲是（.doxyfile）。

默認情況下，在使用OUTPUT_DIRECTORY提供的目錄中創建一個名爲man的子文件夾以包含生成的頁面。

通過這樣做，doxygen將呈現您添加到源代碼中的所有標記作爲手冊頁（每個翻譯單元一頁）。

此時，您可能想要使用exclude* directives排除您想要忽略的某些部分（我假定您有興趣只顯示如何調用主部分）。

我建議你編譯兩個不同的doxyfiles：一個用於內部使用（完整的類似javadoc的文檔），另一個用於生成程序人等。

當然，您在第一次嘗試時不會獲得預期的結果，您可能需要使用doxygen標記進行一些操作。