Jak wyświetlić dokumentację interfejsu API w narzędziach QtCreator?

Question

Qt Creator zapewnia podpowiedzi dla wbudowanych funkcji Qt, tak:

Dodałem jakąś dokumentację do własnej funkcji tak:

 /** 
     * @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; 

Running Doxygen i qhelpgenerator, ja utworzyłem własny plik .qhp i dodałem go do QtCreatora. Jednak Qt Creator nadal nie pokazać moje krótkie podsumowanie w dymku:

Zakładam, że Qt Creator zasadzie uznała mój plik .qhp, ponieważ uderzanie F1 pokazuje wygenerowane dokumenty:

Czy istnieje sposób na uzyskanie krótkich podsumowań w etykietkach narzędzi? Próbowałem wszystkiego w

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

ale nadal nie ma podsumowania.

Answer 1

Sposób, w jaki QtCreator pobiera informacje z plików dokumentacji HTML, wymaga bardzo specyficznej struktury, aby działał.

Na przykład krótkie podsumowanie MyClass należy umieścić między <!-- $$$MyClass-brief --> i <!-- $$$MyClass --> znaków w odpowiednim pliku HTML. Do wyszukiwania podsumowań metod używane są bardziej złożone znaki.

Bez tego krótkie wyodrębnianie nie będzie działało i żadne podsumowanie nie będzie wyświetlane w etykietach narzędzi QtCreator.

Niestety nie jest to dobrze udokumentowane i AFAIK może ulec zmianie w przyszłych wersjach.

Jeśli jesteś naprawdę zainteresowany, możesz rzucić okiem na źródła QtCreator (htmldocextractor.cpp). Przypuszczam, że pliki pomocy Qt (w katalogu Qt/Docs) można uznać za przykłady robocze. Można też wypróbować: .

Skrypt wstawia znaki Qt w plikach HTML generowanych przez Doxygen (a zatem przed wygenerowaniem pliku qch za pomocą programu qhelpgenerator). Udało się to dla mnie, ale nie testowałem go nowszymi wydaniami Doxygen/Qt.