Re: [Development] Lots of qdoc-related warning messages when building 'docs' target in Qt-6.6.0?
Hi, QDoc needs to parse C++ sources to actually generate the API documentation. This requires a build where the modules are actually configured. This explains some of the warnings you see - Qt WebEngine, Qt PDF cannot be built on MinGW, and likewise Qt Wayland (Compositor). Anyway, like Paul said, there are also some warnings even in the official builds ... Kai From: Development on behalf of Haowei Hsu Sent: Sunday, October 22, 2023 5:21 To: Paul Wicking Cc: development@qt-project.org Subject: Re: [Development] Lots of qdoc-related warning messages when building 'docs' target in Qt-6.6.0? Hello, Paul. I've read https://doc.qt.io/qt-6/qdoc-warnings.html, but still don't figure it out. BTW, I also tried to build docs of Qt-6.5.3, and still encountered the same problem. For example: C:/Test/qt-everywhere-src-6.5.3/qtbase/src/gui/image/qicon.cpp:1152: (qdoc) warning: Can't link to 'fallbackIconTheme()' C:/Test/qt-everywhere-src-6.5.3/qtbase/src/gui/image/qicon.cpp:1171: (qdoc) warning: Can't link to 'fallbackIconTheme()' C:/Test/qt-everywhere-src-6.5.3/qtbase/src/gui/kernel/qaction.cpp:139: (qdoc) warning: Can't link to 'Qt Widgets - Application Example' and C:/Test/qt-everywhere-src-6.5.3/qtdoc/doc/src/qtmodules.qdoc:4: (qdoc) warning: Can't link to 'Qt PDF' C:/Test/qt-everywhere-src-6.5.3/qtdoc/doc/src/qtmodules.qdoc:4: (qdoc) warning: Can't link to 'Qt WebEngine' C:/Test/qt-everywhere-src-6.5.3/qtdoc/doc/src/qtmodules.qdoc:4: (qdoc) warning: Can't link to 'Qt Wayland Compositor' C:/Test/qt-everywhere-src-6.5.3/qtdoc/doc/src/wayland-and-qt.qdoc:4: (qdoc) warning: Can't link to 'Qt Wayland Compositor' You can see the full logs in attachment: LOG-still-has-the-qdoc-warning-in-qt-6.5.3.txt Therefore, I think this problem might not be a bug. Instead, I think it's probably because I missed something, but I don't know which part is missing. Could it be that I forgot to add some paths to a specific environment variable? --- Haowei Hsu -- Development mailing list Development@qt-project.org https://lists.qt-project.org/listinfo/development
Re: [Development] Lots of qdoc-related warning messages when building 'docs' target in Qt-6.6.0?
On 22 Oct 2023, at 05:21, Haowei Hsu wrote: Hello, Paul. Hi! I've read https://doc.qt.io/qt-6/qdoc-warnings.html, but still don't figure it out. BTW, I also tried to build docs of Qt-6.5.3, and still encountered the same problem. For example: [snip] You can see the full logs in attachment: LOG-still-has-the-qdoc-warning-in-qt-6.5.3.txt Therefore, I think this problem might not be a bug. Instead, I think it's probably because I missed something, but I don't know which part is missing. Could it be that I forgot to add some paths to a specific environment variable? The QDoc warnings look reasonable for 6.5.3, so I don't think you've done anything wrong. There are, today, roughly 110 QDoc warnings in Qt 6.5, maybe 20-30 fewer in 6.6, and 67 warnings in the current dev branch. There's a diagnostics panel on doc-snapshots.qt.io; click the monkey wrench icon on the right hand side of the title line (which'll contain e.g. "Qt 6.7") to access it. There you'll get a quick over view of the warnings and a dump of what they are. For what it's worth, the documentation for Qt is mostly correct despite the issues reported by QDoc. The html docs contain more than 8000 files, all of which contain tens or hundreds of internal links. Unless you run into a specific problem while browsing the documentation you've built locally, there's no need for you to worry about these issues. However, if you would like to contribute to the Qt project by improving the correctness of the documentation, patches that resolve QDoc warnings are most welcome on codereview.qt-project.org, like Volker suggested. //! Paul -- Development mailing list Development@qt-project.org https://lists.qt-project.org/listinfo/development
Re: [Development] Lots of qdoc-related warning messages when building 'docs' target in Qt-6.6.0?
Hello, Paul. I've read https://doc.qt.io/qt-6/qdoc-warnings.html, but still don't figure it out. BTW, I also tried to build docs of Qt-6.5.3, and still encountered the same problem. For example: C:/Test/qt-everywhere-src-6.5.3/qtbase/src/gui/image/qicon.cpp:1152: (qdoc) > warning: Can't link to 'fallbackIconTheme()' > C:/Test/qt-everywhere-src-6.5.3/qtbase/src/gui/image/qicon.cpp:1171: > (qdoc) warning: Can't link to 'fallbackIconTheme()' C:/Test/qt-everywhere-src-6.5.3/qtbase/src/gui/kernel/qaction.cpp:139: > (qdoc) warning: Can't link to 'Qt Widgets - Application Example' and C:/Test/qt-everywhere-src-6.5.3/qtdoc/doc/src/qtmodules.qdoc:4: (qdoc) > warning: Can't link to 'Qt PDF' > C:/Test/qt-everywhere-src-6.5.3/qtdoc/doc/src/qtmodules.qdoc:4: (qdoc) > warning: Can't link to 'Qt WebEngine' > C:/Test/qt-everywhere-src-6.5.3/qtdoc/doc/src/qtmodules.qdoc:4: (qdoc) > warning: Can't link to 'Qt Wayland Compositor' > C:/Test/qt-everywhere-src-6.5.3/qtdoc/doc/src/wayland-and-qt.qdoc:4: > (qdoc) warning: Can't link to 'Qt Wayland Compositor' You can see the full logs in attachment: *LOG-still-has-the-qdoc-warning-in-qt-6.5.3.txt* Therefore, I think this problem might not be a bug. Instead, I think it's probably because I missed something, but I don't know which part is missing. Could it be that I forgot to add some paths to a specific environment variable? --- Haowei Hsu hwhsu1231@vb-windows MINGW64 ~ $ cd /c/Test/qt-everywhere-src-6.5.3 hwhsu1231@vb-windows MINGW64 /c/Test/qt-everywhere-src-6.5.3 $ rm -rf build hwhsu1231@vb-windows MINGW64 /c/Test/qt-everywhere-src-6.5.3 $ mkdir build && cd build hwhsu1231@vb-windows MINGW64 /c/Test/qt-everywhere-src-6.5.3/build $ mkdir mingw-release && cd mingw-release hwhsu1231@vb-windows MINGW64 /c/Test/qt-everywhere-src-6.5.3/build/mingw-release $ ../../configure -release -nomake examples -nomake tests -- -DFEATURE_system_zlib=OFF -DFEATURE_zstd=OFF + mkdir -p qtbase + cd qtbase + exec /c/Test/qt-everywhere-src-6.5.3/qtbase/configure -top-level -release -nomake examples -nomake tests -- -DFEATURE_system_zlib=OFF -DFEATURE_zstd=OFF -- Windows 10 SDK version: 'C:/msys64/mingw64/bin/cmake.exe' '-DFEATURE_system_zlib=OFF' '-DFEATURE_zstd=OFF' '-DQT_BUILD_EXAMPLES=FALSE' '-DQT_BUILD_TESTS=FALSE' '-DCMAKE_BUILD_TYPE=Release' '-G' 'Ninja' 'C:/Test/qt-everywhere-src-6.5.3' -- The CXX compiler identification is GNU 13.2.0 -- The C compiler identification is GNU 13.2.0 -- The ASM compiler identification is GNU -- Found assembler: C:/msys64/mingw64/bin/cc.exe -- Detecting CXX compiler ABI info -- Detecting CXX compiler ABI info - done -- Check for working CXX compiler: C:/msys64/mingw64/bin/c++.exe - skipped -- Detecting CXX compile features -- Detecting CXX compile features - done -- Detecting C compiler ABI info -- Detecting C compiler ABI info - done -- Check for working C compiler: C:/msys64/mingw64/bin/cc.exe - skipped -- Detecting C compile features -- Detecting C compile features - done -- Checking dependencies of submodule 'qtbase' -- Checking dependencies of submodule 'qtimageformats' -- Checking dependencies of submodule 'qtlanguageserver' -- Checking dependencies of submodule 'qtshadertools' -- Checking dependencies of submodule 'qtsvg' -- Checking dependencies of submodule 'qtdeclarative' -- Checking dependencies of submodule 'qtquicktimeline' -- Checking dependencies of submodule 'qtquick3d' -- Checking dependencies of submodule 'qtmultimedia' -- Checking dependencies of submodule 'qt3d' -- Checking dependencies of submodule 'qt5compat' -- Checking dependencies of submodule 'qtactiveqt' -- Checking dependencies of submodule 'qtcharts' -- Checking dependencies of submodule 'qtcoap' -- Checking dependencies of submodule 'qtconnectivity' -- Checking dependencies of submodule 'qtdatavis3d' -- Checking dependencies of submodule 'qtwebsockets' -- Checking dependencies of submodule 'qthttpserver' -- Checking dependencies of submodule 'qttools' -- Checking dependencies of submodule 'qtserialport' -- Checking dependencies of submodule 'qtpositioning' -- Checking dependencies of submodule 'qtwebchannel' -- Checking dependencies of submodule 'qtwebengine' -- Checking dependencies of submodule 'qtdoc' -- Checking dependencies of submodule 'qtgrpc' -- Checking dependencies of submodule 'qtlocation' -- Checking dependencies of submodule 'qtlottie' -- Checking dependencies of submodule 'qtmqtt' -- Checking dependencies of submodule 'qtnetworkauth' -- Checking dependencies of submodule 'qtopcua' -- Checking dependencies of submodule 'qtquick3dphysics' -- Checking dependencies of submodule 'qtquickeffectmaker' -- Checking dependencies of submodule 'qtremoteobjects' -- Checking dependencies of submodule 'qtscxml' -- Checking dependencies of submodule 'qtsensors' -- Checking dependencies of submodule 'qtserialbus' -- Checking dependencies of submodule 'qtspeech' -- Checking dependencies of submodule 'qttranslations' -- Checking dependencies of submodule 'qtvirtualkeyboard'
Re: [Development] Lots of qdoc-related warning messages when building 'docs' target in Qt-6.6.0?
On 21 Oct 2023, at 11:20, Haowei Hsu wrote: Hello, Volker. To resolve those, make patches to gerrit that fix them :) Do you mean that it is actually a bug? A warning from QDoc indicates that there's an issue in the documentation. The QDoc manual describes how you can go about to resolve them: https://doc.qt.io/qt-6/qdoc-warnings.html --- Haowei Hsu -- Development mailing list Development@qt-project.org https://lists.qt-project.org/listinfo/development -- Development mailing list Development@qt-project.org https://lists.qt-project.org/listinfo/development
Re: [Development] Lots of qdoc-related warning messages when building 'docs' target in Qt-6.6.0?
Hello, Volker. To resolve those, make patches to gerrit that fix them :) Do you mean that it is actually a bug? --- Haowei Hsu -- Development mailing list Development@qt-project.org https://lists.qt-project.org/listinfo/development
Re: [Development] Lots of qdoc-related warning messages when building 'docs' target in Qt-6.6.0?
On 21 Oct 2023, at 10:02, Haowei Hsu wrote: Hello, Qt Development Team. Recently, I successfully built docs of Qt-6.6.0 in MSYS/MINGW64 shell with the following commands: 1. cd /c/Test/qt-everywhere-src-6.6.0 2. mkdir build && cd build 3. mkdir mingw-release && cd mingw-release 4. ../../configure -release -nomake examples -nomake tests -- -DFEATURE_system_zlib=OFF -DFEATURE_zstd=OFF 5. cmake --build . --target docs --parallel 4 Although the HTML documentation is generated, (the following is the screenshot) I noticed that there are lots of 'qdoc-related warning' messages when building 'docs' target in Qt-6.6.0. How to resolve all of these qdoc-related warning messages? What did I miss? Warnings from qdoc are not unusual; our CI system blocks changes that increase the number of warnings, but the base line is not 0 for all repositories. To resolve those, make patches to gerrit that fix them :) Volker -- Development mailing list Development@qt-project.org https://lists.qt-project.org/listinfo/development
