QtCreatorのツールチップにAPIドキュメントを表示するには？

Question

QtCreatorこのように、内蔵されたQtの機能のためのツールチップを提供しています。私は、

 /** 
     * @brief serialize Writes the passed field definition set to the specified device. 
     * @param device Device to write the field definition set to. 
     * @param fieldDefinitionSet Field definition set to write. 
     */ 
     void serialize(QIODevice& device, const FieldDefinitionSet& fieldDefinitionSet) const; 

はDoxygenのとqhelpgeneratorを実行：

私はこのように私自身の機能にいくつかのドキュメントを追加しました自分の.qhpファイルを作成してQtCreatorに追加しました。しかし、QtCreatorはまだツールチップに私の簡単な要約を表示しません：

F1を打つことは生成されたドキュメントを示しているので、私は、QtCreatorは基本的に私の.qhpファイルを認識していることを前提としています

を

ツールチップで簡単な要約を得る方法はありますか？私は

• Qt5 reference documentation: qch files
• Use own documentation in Qt Creator help mode
• Using automatic documentation of my own function with Qt Creator?

まだありません要約ですべてを試みました。

Answer 1

QtCreatorがHTMLドキュメントファイルから情報を抽出する方法は、それが動作するための非常に特殊な構造を必要とします。

たとえば、MyClassの要約は、対応するHTMLファイルの<!-- $$$MyClass-brief -->と<!-- $$$MyClass -->の間に配置する必要があります。メソッド要約ルックアップの場合、より複雑なマークが使用されます。

これがなければ、簡単な抽出は機能しません。QtCreatorのツールチップには要約は表示されません。

悲しいことに、これは十分に文書化されておらず、AFAIKは将来のリリースで変更される可能性があります。

本当に興味があるのなら、QtCreatorソース（htmldocextractor.cpp）をご覧ください。そして、Qtヘルプファイル（Qt/Docsディレクトリ内）はの作業例と考えることができます。

また、お試しください：doxygen2qtcreator。

スクリプトは、これらのQtマークをDoxygenで生成されたHTMLファイルに挿入します（qhelpgeneratorを使用してqchファイルを生成する前に）。それは私のために働いたが、新しいDoxygen/Qtリリースではテストしていない。