Integration of header comments as help

[json_7]

Hi there,
QT Creator is really a great software as it provides auto completion of explaining comments, e.g.:
/**
*@brief
*@param
*@return
*/

So i woundered if it is possible to bind the comments a developer wrote in a header file (of like i did it) as F1-Help in QT Creator.

Does anyone know if it is possible?
Thanks, Cheers!

[artwaw]

You'll need to compile them to the QDoc files and add to Qt Creator, if I am not mistaken.

However, I document header files for use with Doxygen and while working on the project I get hover tolltips from those comments on the go.

[aha_1980]

Hi @json_7,

yeah, that's possible if you create a .qch (Qt compiled help) file with either doxygen or qdoc from these comments.

You will have to google for the exact steps, I've never done that myself.

Regards

[json_7]

Yeah, thank you two. Meanwhile i found out how to do that with doxygen (https://stackoverflow.com/questions/31339007/qtcreator-and-doxygen#34707377).
When you're looking closer you even can see that QTCreator itself calls these comments "doxygen comments".

Cheers

[artwaw]

A bit OT but I wrote a small guide for integrating Doxygen with Qt Creator https://forum.qt.io/topic/109232/including-doxygen-document-generation-in-the-built-process-with-qt-creator