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 실행, I 내 .qhp 파일을 만들어 QtCreator에 추가했습니다. 그러나 QtCreator은 여전히 ​​툴팁 내 간단한 요약을 표시하지 않습니다

나는 F1을 타격하는 것은 생성 된 문서 보여주기 때문에 QtCreator은 기본적으로 내 .qhp 파일을 인식했다고 가정

을

툴팁에서 간략한 요약을 얻을 수있는 방법이 있습니까? 나는

Using automatic documentation of my own function with Qt Creator?

하지만 여전히 요약 Qt5 reference documentation: qch files

Use own documentation in Qt Creator help mode

• 모든 것을 시도했습니다.

Answer 1

QtCreator가 HTML 문서 파일에서 정보를 추출하는 방법은 매우 구체적인 구조가 필요합니다.

예를 들어, MyClass의 간략한 요약은 <!-- $$$MyClass-brief -->과 <!-- $$$MyClass --> 사이의 해당 HTML 파일에 있어야합니다. 메소드 요약 조회의 경우, 더 복잡한 표시가 사용됩니다.

이 항목이 없으면 간단한 추출이 작동하지 않고 QtCreator 툴팁에 요약이 표시되지 않습니다.

슬프게도 이것은 잘 설명되어 있지 않으며 AFAIK는 향후 릴리스에서 변경 될 수 있습니다.

정말로 관심이 있으시면 QtCreator 소스 (htmldocextractor.cpp)를 살펴보십시오. 그리고 Qt 도움말 파일 (Qt/Docs 디렉토리 내)은 작업 예제으로 간주 될 수 있습니다.

시도해 볼 수도 있습니다 : doxygen2qtcreator.

스크립트는 Doxygen 생성 HTML 파일에 이러한 Qt 표시를 삽입합니다 (따라서 qhelpgenerator로 qch 파일을 생성하기 전에). 저에게 도움이되었지만 최신 Doxygen/Qt 릴리즈에서는 테스트하지 않았습니다.