typo in the property definitions

[XiaoGuo, Liu]

https://developer.ubuntu.com/api/apps/qml/sdk-15.04.1/Ubuntu.Components.ScrollView/

on the page:

defaultcontentItem : Item
The contentItem of the ScrollView. This is set by the user. Note that the definition of contentItem is somewhat different to that of a Flickable, where the contentItem is implicitly created.

read-onlyflickableItem : Item

There should be a space in the property defintions.

default contentItem: Item

[Andrea Bernabei (faenil)]

this is a generic documentation problem that applies to all documentation pages.

It seems there's no whitespace added between "readonly" and the property name. Same applies to the property type "Item" etc.

[Launchpad Janitor (janitor)]

Status changed to 'Confirmed' because the bug affects multiple users.

[Pierre Bertet (bpierre)]

Indeed, there is no space between them, it’s a problem coming from the QDoc HTML generator, fixed in the master branch, and there is no way to configure it.

We can see the problem in here: https://github.com/qtproject/qttools/blob/c27a715331df99d087e2c767e678bf7ba4f38d50/src/qdoc/htmlgenerator.cpp#L4217

It has been fixed with this commit: https://github.com/qtproject/qttools/commit/afdbf65a98792b6de5968fa3d1c2f8267af9d838

The commit is in the 5.6 branch of qttools.

Temporary solutions:

- It is possible to visually separate them using CSS since they are in separate <span> elements, but it is not an optimal solution (e.g. screen readers still consider them as a single word).
- Search and replace in HTML files after the generation
- Manipulating the page in JavaScript

[XiaoGuo, Liu (liu-xiao-guo)]

This problem happens to a lot of other API documents. We need to review all of them.

[Andrea Bernabei (faenil)]

as shown by Pierre's analysis above, this is a bug in the html generator that is part of qdoc.
So all documentation pages will have it, because they're generated using the same tool.

If you read Pierre's comment, he also mentions that the bug is already fixed in the upstream qdoc tool in Qt 5.6, and also links the commit that fixes the bug.

We only have to take that commit and apply it to our version of qdoc, since I guess it will still take a few months before we move to Qt5.6 (which is not even released yet).

I hope that's clearer :)

[Launchpad Janitor (janitor)]

Status changed to 'Confirmed' because the bug affects multiple users.

[Timo Jyrinki (timo-jyrinki)]

Funnily, this is in qtbase still in Qt 5.4 and Qt 5.5, it was moved to qttools in Qt 5.6.

[Łukasz Zemczak (sil2100)]

This bug was fixed in the package qtbase-opensource-src 5.4.1+dfsg-2ubuntu11~vivid8 in https://launchpad.net/~ci-train-ppa-service/+archive/ubuntu/stable-phone-overlay

---------------

qtbase-opensource-src (5.4.1+dfsg-2ubuntu11~vivid8) vivid; urgency=medium

  * debian/patches/qdoc-Wrap-QML-read-only-and-default-qualifiers-in-br.patch:
    - Fix typos in property definitions. (LP: #1557259)

 -- Timo Jyrinki <email address hidden> Tue, 22 Mar 2016 09:01:01 +0000

[Launchpad Janitor (janitor)]

This bug was fixed in the package qtbase-opensource-src - 5.5.1+dfsg-16ubuntu6

---------------
qtbase-opensource-src (5.5.1+dfsg-16ubuntu6) xenial; urgency=medium

  [ Alberto Mardegan ]
  * debian/patches/xcb_fix_parent_screen_of_embedded_windows.patch:
    - Fix wrong size of embedded window. Fixed in upstream Qt 5.6.
      (LP: #1564767)

 -- Timo Jyrinki <email address hidden> Tue, 05 Apr 2016 13:59:17 +0000