Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to document Qt based source code

Tags:

c++

qt

qt-creator

How to document the source code I am writing so that other developers see help instructions when hovering the cursor over - for example - a class name I created in Qt creator. I want to do something like the help you get when put the cursor over a Qt class or function name.

like image 303
Ramez Avatar asked Mar 16 '12 16:03

Ramez


People also ask

How do you format Qt?

Select Edit > Preferences > Beautifier > Artistic Style, ClangFormat, or Uncrustify > Format Current File to format the currently open file.

What is TR () in Qt?

tr() is a function that marks a string for international translation. At runtime, the input string will be translated to an appropriate language, based on translations configured in the Qt Linguist tool.

Is Qt Creator an IDE?

Qt Creator is a cross-platform integrated development environment (IDE) built for the maximum developer experience. Qt Creator runs on Windows, Linux, and macOS desktop operating systems and allows developers to create software across desktop, mobile, and embedded platforms.


2 Answers

Doxygen + plugin for QtCreator ( http://dev.kofee.org/projects/qtcreator-doxygen/ ) Just change version in *.pluginspec file to 2.4.1, it you are using latest QtCreator version.
Good luck.

like image 168
Raxillan Avatar answered Sep 30 '22 04:09

Raxillan


Doxygen markup and the Doxygen tool will produce supplemental documentation. The hover over functionality depends on your development environment. Visual Studio is compatible with Doxygen markup. http://www.doxygen.nl/

like image 27
Azazeel Lupin Avatar answered Sep 30 '22 04:09

Azazeel Lupin