Hi,I want to generate documentation with qdoc,and I tried as the qdoc guide told，I can get documentation,but it's not full,I don't know why,can anyone help?thanks. I tried both on: qt 5.11.3 llvm 6.0.1 windows 10 and: qt 5.12.3 llvm 6.0.1 ubuntu 16.04 but it's all the same. here is the code: project.qconconf headerdirs = . sourcedirs = . exampledirs = . imagedirs = ./images sources.fileextensions = "*.cpp *.qdoc *.mm *.qml" headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx" examples.fileextensions = "*.cpp *.h *.js *.xq *.svg *.xml *.ui *.qhp *.qhcp *.qml" examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng" outputdir = html outputformats = HTML mainwindow.cpp /*! * \class MainWindow * \brief mainwindow for ui . */ /*! constructor */ MainWindow::MainWindow(QWidget *parent) : QMainWindow(parent), ui(new Ui::MainWindow) { ui->setupUi(this); } /*! destructor */ MainWindow::~MainWindow() { delete ui; } /*! function test */ bool MainWindow::test() const { return test_; } /*! function setTest */ void MainWindow::setTest(bool test) { test_ = test; } After I execute command "qdoc proect.qdocconf",warning as follows: .../mainwindow.cpp:4: (qdoc) warning: Class MainWindow has no \inmodule command; using project name by default: .../mainwindow.cpp:9: (qdoc) warning: Cannot tie this documentation to anything [I found a /*! ... */ comment, but there was no topic command (e.g., '\fn', '\page') in the comment and no function definition following the comment.] what I got: two file: ".index" and "mainwindow.html" "mainwindow.html": MainWindow Contents Detailed Description MainWindow Class mainwindow for ui interface. More... Detailed Description mainwindow for ui interface. Seems like it can't get any other info except "\class". Any suggestion would be appreciated.

To fix the error, you need to switch to VS2015 Build Tool. For VS2017 I could not get the compiler to work. But for 2015 everything works as expected.

Your browser does not seem to support JavaScript. As a result, your viewing experience will be diminished, and you have been placed in read-only mode.

Please download a browser that supports JavaScript, or enable it if it's disabled (i.e. NoScript).

Why QDoc don't work, it's really confusing.

Unsolved General and Desktop

26 Posts 7 Posters 6.2k Views

M mrjj
25 Apr 2019, 13:38
Hi
Did you change config file to match ?
sample uses
```
headers.fileextensions = "*.hpp"
but often its actually just "*.h"
```
S Offline
S Offline
Stephen INF

wrote on 25 Apr 2019, 13:49 last edited by

#15

@mrjj
Yes，I changed that.
M 1 Reply Last reply 25 Apr 2019, 13:56

0
S Stephen INF
25 Apr 2019, 13:49

@mrjj
Yes，I changed that.
M Offline
M Offline
mrjj
Lifetime Qt Champion
wrote on 25 Apr 2019, 13:56 last edited by

#16

@Stephen-INF
hmm odd. then
it seems clang have issue parsing the header
( QDoc uses clang from Qt 5.11)

You did follow step to install it ?
https://doc.qt.io/qt-5/qdoc-guide-clang.html
S 1 Reply Last reply 25 Apr 2019, 14:01

1
M mrjj
25 Apr 2019, 13:56

@Stephen-INF
hmm odd. then
it seems clang have issue parsing the header
( QDoc uses clang from Qt 5.11)

You did follow step to install it ?
https://doc.qt.io/qt-5/qdoc-guide-clang.html
S Offline
S Offline
Stephen INF

wrote on 25 Apr 2019, 14:01 last edited by

#17

@mrjj
Yes，I did it
installed LLVM6.0.1 and specify Clang location by "set LLVM_INSTALL_DIR=C:\Program Files\LLVM"
M 1 Reply Last reply 25 Apr 2019, 14:21

0
S Stephen INF
25 Apr 2019, 14:01

@mrjj
Yes，I did it
installed LLVM6.0.1 and specify Clang location by "set LLVM_INSTALL_DIR=C:\Program Files\LLVM"
M Offline
M Offline
mrjj
Lifetime Qt Champion
wrote on 25 Apr 2019, 14:21 last edited by

#18

@Stephen-INF
That seems pretty ok.
However, since the other part of generation seems to work, then
it must be something with clang and /fn
But I cant guess what not right.
S 1 Reply Last reply 25 Apr 2019, 14:51

0
M mrjj
25 Apr 2019, 14:21

@Stephen-INF
That seems pretty ok.
However, since the other part of generation seems to work, then
it must be something with clang and /fn
But I cant guess what not right.
S Offline
S Offline
Stephen INF

wrote on 25 Apr 2019, 14:51 last edited by

#19

@mrjj
Well,can you try to generate C++ documentation with QDoc if you are free?
M 1 Reply Last reply 25 Apr 2019, 15:02

0
S Stephen INF
25 Apr 2019, 14:51

@mrjj
Well,can you try to generate C++ documentation with QDoc if you are free?
M Offline
M Offline
mrjj
Lifetime Qt Champion
wrote on 25 Apr 2019, 15:02 last edited by

#20

@Stephen-INF
I might :)
1 Reply Last reply

0
F Offline
F Offline
FrancoF

wrote on 28 May 2019, 12:46 last edited by

#21

@mrjj
Hi, I have a very simila problem.
M 1 Reply Last reply 29 May 2019, 06:11

0
F FrancoF
28 May 2019, 12:46

@mrjj
Hi, I have a very simila problem.
M Offline
M Offline
mrjj
Lifetime Qt Champion
wrote on 29 May 2019, 06:11 last edited by

#22

@FrancoF
Hi
I did try the QDoc but could not get any /fn to work either.

What version of Qt are you using ?
D F 2 Replies Last reply 16 Jun 2019, 10:31

0
M mrjj
29 May 2019, 06:11

@FrancoF
Hi
I did try the QDoc but could not get any /fn to work either.

What version of Qt are you using ?
D Offline
D Offline
DevMachines

wrote on 16 Jun 2019, 10:31 last edited by DevMachines

#23

Re: [Why QDoc don't work](it's really confusing.)
I have the same issue with Qt5.12.0 on Windows. Does anyone have the solution for this?
Some notes - the enumerator was processed without problems:

class MyClass
{
public:
enum Type
{
}
void foo();
}

/*!
\enum MyClass::Type - parsed without errors
\value …
*/

/*!
\fn void MyClass::foo() - error: use of undeclared identifier 'MyClass' why???
*/
1 Reply Last reply

0
D Offline
D Offline
DevMachines

wrote on 20 Jun 2019, 10:35 last edited by

#24

To fix the error, you need to switch to VS2015 Build Tool. For VS2017 I could not get the compiler to work. But for 2015 everything works as expected.
1 Reply Last reply

4
M Offline
M Offline
Michael Scopchanov

wrote on 24 Aug 2019, 05:26 last edited by

#25

Check out this: https://stackoverflow.com/questions/52739030/why-does-q-object-break-qdoc
1 Reply Last reply

1
M mrjj
29 May 2019, 06:11

@FrancoF
Hi
I did try the QDoc but could not get any /fn to work either.

What version of Qt are you using ?
F Offline
F Offline
FrancoF

wrote on 27 Aug 2019, 13:01 last edited by

#26

@mrjj
Qt 5.12.4 (GCC 9.1.0, 64 bit) installed on MSYS.
1 Reply Last reply

0