QDoc is a tool used by Qt Developers to generate documentation for software projects.
Documentation can be found here (Qt5).
Questions tagged [qdoc]
15 questions
22
votes
1 answer
//! [0] in Qt source code
What is the meaning of the //! [n] (n = 0, 1, 2 ...) markup in the C++/QML sources in the Qt sample projects?
For example:
//! [0]
GLWidget::GLWidget(Helper *helper, QWidget *parent)
: QGLWidget(QGLFormat(QGL::SampleBuffers), parent),…
Mkoch
- 1,994
- 2
- 13
- 21
10
votes
3 answers
Declaring operator== for a nested template class
I have a following nested template class inside another template class:
template
struct A
{
template
struct B {};
};
What would be the signature of a non-member operator== for the nested type B? The following naïve…
Resurrection
- 3,916
- 2
- 34
- 56
7
votes
2 answers
Why does Q_OBJECT break QDoc?
Problem
Since the upgrade from Qt 5.10 to Qt 5.11 I have started having problems to generate a documentation with QDoc for my existing projects.
One of the many issues are missing functions in the documentation, although the corresponding comments…
scopchanov
- 7,966
- 10
- 40
- 68
2
votes
0 answers
qdoc does not generate HTML
Even my question is similar to this one, the answer provided does not solve my issue.
I'm trying to generate my first QDoc output.
To test it, right now I have only one comment in main.cpp:
/*!
* \brief main
* \param argc
* \param argv
*…
Mark
- 4,338
- 7
- 58
- 120
1
vote
0 answers
QDoc can generate documentation,but content is not full
I want to generate documentation with QDoc and I tried as the QDoc guide told. I can get documentation, but it's not complete.
I tried both on:
qt 5.11.3, llvm 6.0.1, windows 10
qt 5.12.3, llvm 6.0.1, ubuntu 16.04
but it's all the same.
Here is…
StephenXu
- 21
- 3
1
vote
1 answer
Where is the qdoc executable?
Seems like I just can't find the QDoc executable.
I downloaded Qt 5.11.1.
Do I need to download QDoc separately?
I checked the docs, but all it says is:
To run qdoc from the command line, give it the name of a configuration file:
$ ../../bin/qdoc…
ecstrema
- 543
- 1
- 5
- 20
1
vote
1 answer
Does QDoc support DITAXML or only HTML?
Does QDoc actually support DITAXML documentation? I am able to create HTML documentation but using DITAXML causes this error.
Unknown output format 'DITAXML'
at the following line in .qdocconf file
outputformats = DITAXML
I see the official…
user1429322
- 1,266
- 2
- 24
- 38
0
votes
1 answer
Cannot configure QDoc when configuring Qt 6.2.4 because of missing libclang
I am trying to build Qt 6.2.4 from source on Windows 10. I run into the following WARNINGs when configuring.
WARNING: QDoc will not be compiled, probably because libclang could not be located. This means that you cannot build the Qt…
CompSciDude
- 3
- 2
0
votes
0 answers
QDoc overwrite html files
I use qdoc for creating code documentation.
I can generate my documents from comments, but I need to delete the old generated files before replacing them with new ones.
As an illustration, when I execute the command qdoc project.qdocconf, it gives…
Mohammad Golkar
- 43
- 1
- 4
0
votes
1 answer
QML/qdoc : How to define inheritance and import statement
I made a qml library and I now want to make a documentation. I use QDoc with Qt 5.10.10 with msvc2015 and LLVM 9.0.0.
I would like to display the 2 following data:
inheritance: I tried to use \inherits but I don't see any result. I tried to use an…
The friendly stranger
- 93
- 1
- 8
0
votes
0 answers
How to specify the way a code snippet is marked up?
Goal
For documentation purposes I would like to export a C++ code snippet from QtCreator as an HTML file and then use CSS to highlight its syntax, for example like that:
Since QtCreator does not have an export option, I am using QDoc to achieve…
scopchanov
- 7,966
- 10
- 40
- 68
0
votes
2 answers
QML/qdoc : How to define inheritance and important statement for my qml components?
I am writting a documentation for my QML project with QDoc. So far, I am able to make a simple one with a description of my functions/signals/properties. Now, I would like to define the inheritance and the important statements like in the Qt doc…
The friendly stranger
- 93
- 1
- 8
0
votes
0 answers
How to make QDoc shipped with Qt 5.11.2 work under Windows 7?
I have recently moved to Qt 5.11.2.
When I try to run qdoc.exe as an external tool from Qt Creator:
%{CurrentProject:QT_INSTALL_BINS}\qdoc.exe
with the following arguments:
%{CurrentProject:Path}/%{CurrentProject:Name}.qdocconf
in the General…
scopchanov
- 7,966
- 10
- 40
- 68
0
votes
1 answer
How to doxygen comment function with Q_INVOKABLE
For example, I have two functions A & B like:
void aFunction();
Q_INVOKABLE void bFunction();
Enter /** before function delcaration and press enter:
/**
* @brief A
*/
void aFunction();
/**
Q_INVOKABLE void bFunction();
Is this a BUG?
OS:…
JustWe
- 4,250
- 3
- 39
- 90
0
votes
1 answer
qbs does not invoke qdoc
All is in question I provided a simple qdocconf file along with my project but, qbs does not invoke qdoc while the qdocconf is in the files property of the project.
Project.qbs
import qbs
Project {
name: "LoggingMessageHandler"
Product {
…
Houss_gc
- 727
- 5
- 27