使用Doxygen的Qt樣式文檔？

Question

如何用Doxygen生成Qt風格的文檔（Trolltech的C++ Qt或Riverbank的PyQt文檔）？我記錄Python，我希望能夠改進它產生的默認功能簡介。

特別是，我希望能夠看到返回類型（可以是用戶指定的）和函數摘要中的參數。

例如：

Functions: 

    int getNumber(self) 
    str getString(self) 
    tuple getTuple(self, int numberOfElements=2) 

Function Documentation: 

    int getNumber(self) 

      gets the number of items within a list as specified... 

      Definition at line 63 of .... 

    etc... 

如果無法做到這一點無需修改源，也許有比其他的Doxygen其他工具來處理Python的文檔在這種方式？

Answer 1

那麼只需使用Doxygen？ This will get you started：

這是用於自動生成 文檔導向關的使用的Doxygen的Python 源代碼。

顯然，由於Python沒有強類型，因此指定返回類型和參數的預期類型將取決於文檔編寫者。無論如何，這只是最佳做法。

Answer 2

如果你在做關於Python的任何相關文檔，我推薦Sphinx。這是Python的開發人員用於他們的文檔。

Answer 3

This page似乎詳細介紹了創建qt樣式文檔的方法。
基本上有一個工具，你可以用qt調用qhelpgenerator創建一個.qch文件，可以由qt助手使用。
我以前沒有用過它，但看起來相當簡單。

Answer 4

您不必在代碼中放置doxygen註釋。你可以把文檔放在其他地方。在doxygen手冊中查看this頁面。