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

Qt Quick documentation fix: Fix the QtQuick and QtQml documentation

    XMLWordPrintable

Details

    Description

      Umbrella task:

      Qt Quick and Qt QML modules need to be sanitized and have content.

      Both modules:
      -sanitize the QML types and the basic types (enumerations, var, int, date, and so on.)
      -make sure that the QML types have the proper import (both use QtQuick 2.0)
      -enforce the proper terminologies
      -use the proper documentation style
      -use the QML module identifier

      Qt Quick:
      1)Add these types

      • color
      • font
      • vector3d

      2)sanitize the types (elements) with the proper style:

      • needs \brief
      • needs proper title (No "Using", "QML States", and no "Overview of" or "Intro to") There should only be ONE "Introduction to:"

      3)sanitize the Qt Quick module page (http://doc-snapshot.qt-project.org/5.0/qtquick-module.html) Should link to the QML interface. Search for \qmlmodule
      4)Add a landing page (QML/JavaScript + UI implementation + tools)
      5)Create overviews (ask Jerome Pasion)

      Qt QML:
      1)Sort the list of types in Qt QML and list their import statements
      2)Sanitize the types and the classes with the proper style:

      • needs \brief
      • links work

      3)sanitize the Qt QML module page (http://doc-snapshot.qt-project.org/5.0/qtqml-module.html) Search for \qmlmodule
      4)Add JavaScript related content
      5)Create overviews (ask Jerome Pasion)

      Not exclusive

      Attachments

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

        Activity

          People

            jerome.pasion Jerome Pasion
            jerome.pasion Jerome Pasion
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes