[Qt-creator] How to make QtCreator to show pop-up documentation of my functions?

[Ziller Eike]

> On Jan 28, 2015, at 11:55 AM, mat //common mail <mat.common at gmail.com> wrote:
> 
> Hi,
> 
> Is it possible when I place the mouse pointer over my function/class it shows a pop-up with description, taken from the docs in the comment above the function/class?
> (Qt Creator 3.1.2, without doxygen plugin)

Currently not directly.
It *should* work if you generate a .qch for your documentation with qdoc or doxygen (*), and register that in Qt Creator’s options > Help > Documentation.

(*)
Generating qhp with doxygen:
http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_generate_qhp
Generating qhp with qdoc:
http://doc-snapshot.qt-project.org/qdoc/22-creating-help-project-files.html
Generating qch from qhp:
http://doc.qt.io/qt-5/qthelp-framework.html#generating-qt-help


> /*!
> * Description for this function...
> * \return The first message...
> */
> QString MessageQueue::get()
> {
>   QString res;
>   ...
>   return res;
> }
> 
> void MessageQueue::nextMessage()
> {
>   QString res = get(); // I want to view pop-up with my docs when the mouse pointer is over the function name.
> }
> 
> 
> _______________________________________________
> Qt-creator mailing list
> Qt-creator at qt-project.org
> http://lists.qt-project.org/mailman/listinfo/qt-creator

-- 
Eike Ziller, Senior Software Engineer - The Qt Company GmbH
 
The Qt Company GmbH, Rudower Chaussee 13, D-12489 Berlin
Geschäftsführer: Mika Pälsi, Juha Varelius, Tuula Haataja
Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 144331 B