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

Alan Alpert 416365416c at gmail.com
Mon Dec 2 19:19:08 CET 2013

On Mon, Dec 2, 2013 at 1:06 AM, Smith Martin <Martin.Smith at digia.com> wrote:
> 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 ?

If it's been associated with a QML type, yes.

There is the situation of a C++ type with C++ properties which is not
exposed to QML - don't want to document that.

But if we have a \qmltype which \instantiates it, then any C++
properties need to be considered QML properties as well (it helps if
\internal works with \qmlproperty for the ones that are meant to be
hidden ;) ).

Alan Alpert

More information about the Development mailing list