Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-139287

Remove C++ references from QML/QtQuick documentation

XMLWordPrintable

    • qtquickcleandoc

      For the general use-case of QML/QtQuick technologies with other languages, it's required that the documentation can be written in a way that people can get a good understanding without having to know details for a specific programming language.

      One example is the current Qt Quick documentation https://doc.qt.io/qt-6/qtquick-index.html that mentions the C++ API. (similarly with Qt QML https://doc.qt.io/qt-6/qtqml-index.html )

      The goal is for people to learn QML/QtQuick without the need of knowing C+{}{}, so this can enable projects like Qt Bridges to refer to those docs, without requiring users to be familiar with C+ details.

      On the other hand, we need to be careful that existing documentation targeting Qt/C++ developers can still be found, especially the parts which are relevant for deep integration. Consequently, we need to consider a few cases:

      1. There should be a C++ free introduction to QML/QtQuick – with some additional focus on Controls, not on pure QtQuick. We might want to take some inspiration from the QtQuick learning path from https://academy.qt.io
      2.  We need to keep our reference documentation for QML types intact; but it should become usable without C++ knowledge.

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

            docteam Qt Documentation Team
            crmaurei Cristian Maureira-Fredes
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:

                There are no open Gerrit changes