Active9 months ago
Where can I find documentation for Qt documentation comments? I'm referring to how Qt uses a specific style for documentation comments, like so:
...you get the picture. So where can I find information about all the switches, like class, list, brief, etc. Also, what tool(s) do I use to generate documentation files from these comments in my source files? Does Doxygen support this syntax?
Jake PetroulesWhile the original version of Qt’s PDF engine just creates documents that conform to version 1.4, nowadays it is more and more important to conform to the PDF/A standard. If you haven’t heard about it yet, PDF/A is an ISO-standard that describes a subset of PDF which should be used for archiving of digital documents.
Jake Petroules- Cross-platform C development using Qt. Qt tools overview. Documentation. Third-party integration. QT Presentation Cross-platform, consistent API. Use the standard native tools to build Qt apps (IDE, debugger etc.). Qt provides a platform-independent encapsulation of the.
- The Qt Object Model a very powerful mechanism for seamless object communication called signals and slots queryable and designable object properties powerful events and event filters contextual string translation for internationalization sophisticated interval driven timers that make it possible to elegantly integrate many tasks in an event-driven GUI.
12.6k29 gold badges125 silver badges212 bronze badges
closed as off-topic by EJoshuaS, TylerH, Makyen, robinCTS, KeLiuyueDec 25 '17 at 3:45
This question appears to be off-topic. The users who voted to close gave this specific reason:
- 'Questions asking us to recommend or find a book, tool, software library, tutorial or other off-site resource are off-topic for Stack Overflow as they tend to attract opinionated answers and spam. Instead, describe the problem and what has been done so far to solve it.' – EJoshuaS, TylerH, Makyen, robinCTS, KeLiuyue
4 Answers
Don't use qdoc. It is deprecated. Use Doxygen, which is based on qdoc anyway.
That said, the documentation (in qdoc format :-D ) is here.
BaCaRoZzo6,2826 gold badges38 silver badges65 bronze badges
smlsml
There are two parts of doxygen that are qt-specific: the Qt Comment Style and the QT_AUTOBRIEF Doxyfile configuration tag. These are simply parts of doxygen that are used by QT. All doxygen comments used by QT are regular doxygen stuff. So you just need to read up on doxygen.
Or perhaps are you really looking for documentation of QT internals, such as information on d-Pointers as contained in this blog entry
Qt Style Comments:The
/*! text */
comment style is called the 'Qt Style' of doxygen comments. The !
marks the entire comment block as a doxygen comment block. It is a standard, optional part of doxygen. QT_AUTOBRIEF setting:if the 'QT_AUTOBRIEF' tag is set to TRUE in the Doxyfile, the first line of a Qt style comment block is automatically interpreted as the brief description.
From the doygen GUI help:
QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first line (until the first dot) of a Qt-style comment as the brief description. If set to NO, the comments will behave just like regular Qt-style comments (thus requiring an explicit brief command for a brief description.)
albertQt Tutorial Pdf
3,5283 gold badges12 silver badges25 bronze badges
sschilzsschilz
Use doxygen to create documentation
It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (LaTeX) from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.
You can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. You can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.
albert3,5283 gold badges12 silver badges25 bronze badges
Qt 5 Pdf
PardeepPardeep
You can take a look at the Qt source code itself for the Qt documentation comments...
I have used DOxygen for documentation and for me it's working fine, though the documentation standards are not of Qt. I suggest you to give it a try though and decide.
liaKliaKQt Documentation Pdf
8,92510 gold badges38 silver badges69 bronze badges