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... 

これはソースを変更せずにできない場合は、多分道のこの種のPythonドキュメントを処理したDoxygen以外の別のツールはありますか？

Answer 1

次に、Doxygenを使用しますか？ This will get you started：

これはDoxygenのを使ってPython ソースコードのオフ自動的 生成ドキュメントのためのガイドです。

明らかに、Pythonは強く型付けされていないので、戻り値の型とパラメータの予想される型の指定は、ドキュメントライターに任されます。それはとにかくベストプラクティスです。

Answer 2

もしPythonに関するドキュメントがあれば、私はSphinxをお勧めします。これはPythonの開発者がドキュメンテーションに使うものです。

Answer 3

This pageは、qt形式のドキュメントを作成する方法を詳しく見ています。
基本的に、Qtアシスタントが編集可能な.qchファイルを作成するqhelpgeneratorというqtを入手するツールがあります。
私はこれまで使用していませんでしたが、かなり簡単です。

Answer 4

コードにdoxygenコメントを入れる必要はありません。別の場所にドキュメントを置くことができます。 doxygenマニュアルのthisページをご覧ください。