[Development] qdoc for C++ and QML

Martin Smith Martin.Smith at qt.io
Tue Apr 25 08:05:38 CEST 2017


>F.e I have a couple of C++ methods, that serve no other purpose than to
>make another C++ API accessible from QML. And the other way round I don't
>want to see the API, that is made for the C++ use case being visible in
>the QML docs - even if technically being invokable.

Use \internal in their qdoc comments to tell qdoc not to include them.
________________________________________
From: Development <development-bounces+martin.smith=qt.io at qt-project.org> on behalf of Uwe Rathmann <Uwe.Rathmann at tigertal.de>
Sent: Tuesday, April 25, 2017 6:57:18 AM
To: development at qt-project.org
Subject: Re: [Development] qdoc for C++ and QML

On Mon, 24 Apr 2017 17:09:43 +0000, Martin Smith wrote:

> It doesn't need a separate comment, just something in the one common
> comment that indicates the class is both C++ and QML.

Most of the decisions about what parts of the APIs have to go to the QML
docs can indeed be made without any additional tags, but IMO there is
still a need for being able to explicitly qualify certain parts as QML or
C++ only.

F.e I have a couple of C++ methods, that serve no other purpose than to
make another C++ API accessible from QML. And the other way round I don't
want to see the API, that is made for the C++ use case being visible in
the QML docs - even if technically being invokable.

Uwe

_______________________________________________
Development mailing list
Development at qt-project.org
http://lists.qt-project.org/mailman/listinfo/development



More information about the Development mailing list