[Development] Can the "hidden" QML properties please be documented?

Smith Martin Martin.Smith at digia.com
Mon Dec 2 10:06:44 CET 2013

For a QML type in a .qml file, qdoc reports an error if it sees a QML property it thinks should be in the public API for that QML type and there is no \qmlproperty comment immediately preceding that property in the .qml file.

But for a QML type that is represented by a C++ class, qdoc doesn't know which C++ properties are meant to be be documented as QML properties, so it can't report an error if a C++ property is not documented as a QML property.

Maybe we should change this policy and tell qdoc to require a \qmlproperty for every C++ property that has a \property ?

From: development-bounces+martin.smith=digia.com at qt-project.org [development-bounces+martin.smith=digia.com at qt-project.org] on behalf of Alan Alpert [416365416c at gmail.com]
Sent: Monday, December 02, 2013 7:32 AM
To: Mark Gaiser
Cc: development at qt-project.org
Subject: Re: [Development] Can the "hidden" QML properties please be    documented?

On Sun, Dec 1, 2013 at 4:25 AM, Mark Gaiser <markg85 at gmail.com> wrote:
> On Sun, Dec 1, 2013 at 11:09 AM, Nurmi J-P <jpnurmi at digia.com> wrote:
>> On 01 Dec 2013, at 00:42, Mark Gaiser <markg85 at gmail.com> wrote:
>>> Hi,
>>> Recently i was searching for a way to influence the "dragDistance" in
>>> QML. The documentation (i even looked at dev snapshot docs) didn't
>>> provide any clue, but the code did. Turns out there is a hidden
>>> property:
>>> drag.threshold (it is underlined in red in QtCreator, but works just fine!).
>> Perhaps you're reading Qt 5.1.x docs? MouseArea::drag::threshold is a new property that was added in September. The documentation is there in the latest snapshot: http://doc-snapshot.qt-project.org/qt5-release/qml-qtquick-mousearea.html
>>> For font rendering there is the hidden property:
>>> renderType
>>> Which works just fine, but is nowhere to be found in the Qt documentation.
>> QQuickText::renderType was indeed missing from the docs. It has been fixed in Qt 5.2.0:
>> - https://bugreports.qt-project.org/browse/QTBUG-35018
>> - https://codereview.qt-project.org/#change,72391
>> --
>> J-P Nurmi
> That's awesome!
> It still makes me wonder, how many more are "hidden"? I hope none :)

I hope so too, as it's usually a doc bug. Feel free to file further
issues like this on bugreports.qt-project.org .

Alan Alpert
Development mailing list
Development at qt-project.org

More information about the Development mailing list