Create context Help when mouse pointer is on a text when coding
-
wrote on 31 Jan 2020, 04:36 last edited by
Hello everyone ,
i got stuck when i want to create a help documentation for my
code to guide users can use my library properly .
My question as title and i look forward any help soon.
Thank you in advance and forgive my english ability limitation. -
First: document your code. This will allow Qt Creator (is that your IDE?) to recognize documentation comments and will display them on hover automatically.
If you want to install documentation like Qt has it (F1 takes you to full class documentation), you need to generate .qch help file from your project, then manually install it to Qt Creator.
A good documentation tool which will help you do all that is doxygen.
-
First: document your code. This will allow Qt Creator (is that your IDE?) to recognize documentation comments and will display them on hover automatically.
If you want to install documentation like Qt has it (F1 takes you to full class documentation), you need to generate .qch help file from your project, then manually install it to Qt Creator.
A good documentation tool which will help you do all that is doxygen.
-
Here is the documentation entry for .qch generation in doxygen: http://doxygen.nl/manual/config.html#cfg_qch_file
1/4