> On 25 Apr 2017, at 14:09, Alberto Mardegan
> wrote:
>
> On 25/04/2017 09:29, Martin Smith wrote:
>>> What would be incorrect as those APIs are only internal for C++, but
>>> public for QML or v.v.
>>
>> Then we need \cpponly and \qmlonly, or something like that.
>
> This is calling for futu
On 25/04/2017 09:29, Martin Smith wrote:
>> What would be incorrect as those APIs are only internal for C++, but
>> public for QML or v.v.
>
> Then we need \cpponly and \qmlonly, or something like that.
This is calling for future headaches, when you start adding python or
other languages.
It's b
On Mon, Apr 24, 2017, at 05:08 PM, Shawn Rutledge wrote:
> > And if a C++ class has a corresponding QML type, should every member
> > function be included in the documentation for both? How will qdoc know that
> > a member function only applies to the C++ class or only to the QML type?
>
> Q_INV
On mandag 24. april 2017 14.05.17 CEST Sean Harmer wrote:
> Hi,
>
> are there any plans to reduce/remove the redundancy when writing
> documentation for both C++ and QML? Seems a waste of time to have to
> copy/paste or update the docs twice for both languages when really the
> only things differi
Hi,
btw, we are facing a similar problem when generating the documentation
for the PySide2 project (Python bindings for Qt). The code snippets are
different; most of the text is similar.
So, the issue could be generalized for any language bindings of Qt.
Regards, Friedemann
--
Friedemann Kl
AM
To: development@qt-project.org
Subject: Re: [Development] qdoc for C++ and QML
On Tue, 25 Apr 2017 06:05:38 +, Martin Smith wrote:
> Use \internal in their qdoc comments to tell qdoc not to include them.
What would be incorrect as those APIs are only internal for C++, but
public for QML or
> On 24 Apr 2017, at 16:17, Sean Harmer wrote:
>
> Hi,
>
> On 24/04/2017 14:23, Martin Smith wrote:
>> Regarding documenting both C++ and QML at the same time, I will be happy to
>> implement it if we can get a good idea for how to do it.
>
> Well, take https://codereview.qt-project.org/#/c/1
On Tue, 25 Apr 2017 06:05:38 +, Martin Smith wrote:
> Use \internal in their qdoc comments to tell qdoc not to include them.
What would be incorrect as those APIs are only internal for C++, but
public for QML or v.v. And sometimes you have "see also" references
inside of docs for a method t
internal in their qdoc comments to tell qdoc not to include them.
From: Development on
behalf of Uwe Rathmann
Sent: Tuesday, April 25, 2017 6:57:18 AM
To: development@qt-project.org
Subject: Re: [Development] qdoc for C++ and QML
On Mon, 24 Apr 2017 17:09
On Mon, 24 Apr 2017 17:09:43 +, 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 addi
_
From: Development on
behalf of Uwe Rathmann
Sent: Monday, April 24, 2017 5:37:39 PM
To: development@qt-project.org
Subject: Re: [Development] qdoc for C++ and QML
On Mon, 24 Apr 2017 15:08:25 +, Shawn Rutledge wrote:
> I guess we haven’t run into this very frequently yet because so few
>
___
From: Shawn Rutledge
Sent: Monday, April 24, 2017 5:08:25 PM
To: Martin Smith
Cc: development@qt-project.org
Subject: Re: [Development] qdoc for C++ and QML
> On 24 Apr 2017, at 16:38, Martin Smith wrote:
>
> The problem when combining C++ and QML documentation is qdoc has no
On Mon, 24 Apr 2017 15:08:25 +, Shawn Rutledge wrote:
> I guess we haven’t run into this very frequently yet because so few
> classes have both a C++ and a QML API within the same class.
Well, this is exactly my use case. All my controls are 100% implemented
in C++ offering a full featured C
> On 24 Apr 2017, at 16:38, Martin Smith wrote:
>
> The problem when combining C++ and QML documentation is qdoc has no way of
> knowing whether a QML type exists for a C++ class or whether a C++ class
> exists for a QML type.
>
> Should we add a new command like \cpp-qml to indicate that bot
: Monday, April 24, 2017 4:17:58 PM
To: development@qt-project.org
Subject: Re: [Development] qdoc for C++ and QML
Hi,
On 24/04/2017 14:23, Martin Smith wrote:
> Regarding documenting both C++ and QML at the same time, I will be happy to
> implement it if we can get a good idea for how to
Sent: Monday, April 24, 2017 3:05:17 PM
To: development@qt-project.org
Subject: [Development] qdoc for C++ and QML
Hi,
are there any plans to reduce/remove the redundancy when writing
documentation for both C++ and QML? Seems a waste of time to have to
copy/paste or update the docs twice for bot
On 24/04/2017 14:26, Friedemann Kleint wrote:
Hi,
For starters, take a look at the script:
http://code.qt.io/cgit/qt-creator/qt-creator.git/tree/scripts/qdoc2tasks.pl?h=4.3
You can pipe the error output of qdoc through it to convert it to a Qt
Creator task file. Opening it in Qt Creator wil
Hi,
For starters, take a look at the script:
http://code.qt.io/cgit/qt-creator/qt-creator.git/tree/scripts/qdoc2tasks.pl?h=4.3
You can pipe the error output of qdoc through it to convert it to a Qt
Creator task file. Opening it in Qt Creator will show the issues as
build issues (see http://do
behalf of Sean Harmer
Sent: Monday, April 24, 2017 3:05:17 PM
To: development@qt-project.org
Subject: [Development] qdoc for C++ and QML
Hi,
are there any plans to reduce/remove the redundancy when writing
documentation for both C++ and QML? Seems a waste of time to have to
copy/paste or updat
Hi,
are there any plans to reduce/remove the redundancy when writing
documentation for both C++ and QML? Seems a waste of time to have to
copy/paste or update the docs twice for both languages when really the
only things differing are the "Q" prefix on the class names in C++.
On a related no
20 matches
Mail list logo
