** Description changed: - The Qt offline documentation for cosmic is incomplete. In fact there's - virtually no content what so ever. It would be easier I think to list - what actually got picked up that what was missed. + [Impact] + The packaged Qt documentation, which can be viewed in browser (qt*-doc-html packages) or in Qt Assistant (qt*-doc packages) is missing all documentation generated from C++ files. Only the static text is present. + + Qt is split by many modules (qtbase, qtdeclarative, qtwebengine, etc.). + I am now fixing it for qtbase, the largest module, but I may fix it for + other modules if someone requests it. + + [Test Case] + 1. Install qtbase5-doc-html package. + 2. Make sure /usr/share/qt5/doc/qtcore/qobject.html is present. + + [Regression Potential] + The proposed fix only adds a new build-dependency. There is absolutely no regression potential. + + [Other Info] + Description of the fix: + + qdoc is a tool that parses C++ source files and generates documentation + from them. Recently, qdoc began using clang instead of its own C++ + parser. Clang needs the C++ standard library to work. qdoc build system + uses a build-time macro (CLANG_RESOURCE_DIR) that hard-codes the path to + standard library in the executable: + https://code.qt.io/cgit/qt/qttools.git/tree/src/qdoc/qdoc.pro?h=5.11#n19. + + From qttools-opensource-src 5.11.1-5 build log in Cosmic amd64, one can + see that qdoc was compiled with + -D'CLANG_RESOURCE_DIR="/usr/lib/llvm-6.0/lib/clang/6.0.1/include"'. So + this directory needs to be present when qdoc is used. This directory is + provided by libclang-common-6.0-dev package. So adding it to build- + dependencies makes the documentation build correctly. + + This is the minimal fix for Cosmic. For Ubuntu 19.04, I will try to use + a better solution like moving the clang standard library detection from + build time to run time, or making qttools5-dev-tools depend on the + needed -dev packages. + + [Original Description] + The Qt offline documentation for cosmic is incomplete. In fact there's virtually no content what so ever. It would be easier I think to list what actually got picked up that what was missed.
-- You received this bug notification because you are a member of Ubuntu Touch seeded packages, which is subscribed to qtbase-opensource-src in Ubuntu. https://bugs.launchpad.net/bugs/1799111 Title: lots of Classes missing from docs (e.g. QFileInfo) Status in qtbase-opensource-src package in Ubuntu: New Status in qtbase-opensource-src package in Debian: Unknown Bug description: [Impact] The packaged Qt documentation, which can be viewed in browser (qt*-doc-html packages) or in Qt Assistant (qt*-doc packages) is missing all documentation generated from C++ files. Only the static text is present. Qt is split by many modules (qtbase, qtdeclarative, qtwebengine, etc.). I am now fixing it for qtbase, the largest module, but I may fix it for other modules if someone requests it. [Test Case] 1. Install qtbase5-doc-html package. 2. Make sure /usr/share/qt5/doc/qtcore/qobject.html is present. [Regression Potential] The proposed fix only adds a new build-dependency. There is absolutely no regression potential. [Other Info] Description of the fix: qdoc is a tool that parses C++ source files and generates documentation from them. Recently, qdoc began using clang instead of its own C++ parser. Clang needs the C++ standard library to work. qdoc build system uses a build-time macro (CLANG_RESOURCE_DIR) that hard- codes the path to standard library in the executable: https://code.qt.io/cgit/qt/qttools.git/tree/src/qdoc/qdoc.pro?h=5.11#n19. From qttools-opensource-src 5.11.1-5 build log in Cosmic amd64, one can see that qdoc was compiled with -D'CLANG_RESOURCE_DIR="/usr/lib/llvm-6.0/lib/clang/6.0.1/include"'. So this directory needs to be present when qdoc is used. This directory is provided by libclang-common-6.0-dev package. So adding it to build- dependencies makes the documentation build correctly. This is the minimal fix for Cosmic. For Ubuntu 19.04, I will try to use a better solution like moving the clang standard library detection from build time to run time, or making qttools5-dev-tools depend on the needed -dev packages. [Original Description] The Qt offline documentation for cosmic is incomplete. In fact there's virtually no content what so ever. It would be easier I think to list what actually got picked up that what was missed. To manage notifications about this bug go to: https://bugs.launchpad.net/ubuntu/+source/qtbase-opensource-src/+bug/1799111/+subscriptions -- Mailing list: https://launchpad.net/~touch-packages Post to : touch-packages@lists.launchpad.net Unsubscribe : https://launchpad.net/~touch-packages More help : https://help.launchpad.net/ListHelp
