web-dev-qa-db-ja.com

Qt Creatorで自分の関数の自動ドキュメントを使用しますか？

私はQt Creatorを使用していて、作成した関数をドキュメント化したいと思ったので、カーソルを関数定義の上に置き、/**<ENTER> そのようです：

/**<ENTER>
void MyClass::myFunction(int myArg)
{
...

Qt Creatorはそのコメントを自動拡張しました：

/**
 * @brief MyClass::myFunction
 * @param myArg
 */
void MyClass::myFunction(int myArg)
{
...

これは何ですか？どこに記載されていますか？

これを使用して自分のQt Assistant qchヘルプファイルなどを生成できますか？

c++qtdocumentationqt-creator
17
Cory Klein

それは here または here として文書化されるべきですが、そうではありません...

だからここにそれに関するいくつかの情報があります：

この機能の設定はここにあります：

Windows：

Qt Creator>ツール>オプション>テキストエディター>完了>ドキュメントコメント

Mac OS X：

Qt Creator>設定>テキストエディター>完了>ドキュメントコメント

表示される3つのオプションは次のとおりです。

  • Doxygenブロックを有効にする
  • 簡単な説明を生成する
  • 先頭のアスタリスクを追加する

（Qt 2.6で見つかりましたが、以前のバージョンでも見つかるかもしれません。または、ある時点で設定されているデフォルトのプラグインの一部である可能性があります。）

作成されるスタブは、doxygenスタイルのスタブです。

Doxygenを使用してソースコードを実行し、chmファイルとhtmlドキュメントとpdfの両方でいくつかの豪華なドキュメントを作成できます。

http://www.doxygen.nl/

http://www.doxygen.nl/manual/output.html （qchファイルを含む）

Qt Creatorの関連プラグインは次のとおりです。

http://dev.kofee.org/projects/qtcreator-doxygen/wiki

そして、あなた自身のプログラムでQHelpEngineを使う...

http://qt-project.org/doc/qt-4.8/qthelp-framework.html

そして最後に、QDesktopServicesを使用して、ヘルプスタイルのURLを処理できます。

http://doc-snapshot.qt-project.org/4.8/qdesktopservices.html#url-handlers

お役に立てば幸いです。

30
phyatt