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

Quick 3D: documentation for 5.14 release

    XMLWordPrintable

    Details

    • Type: User Story
    • Status: Closed
    • Priority: P1: Critical
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Quick: 3D
    • Labels:
      None
    • Sprint:
      Qt Quick 3D - wk 45/46

      Description

      The documentation for the Qt Quick 3D module needs to be in a complete state for release along with Qt 5.14 as a tech preview so that users are able to actually to use this new module and give feedback.

      Getting the documentation into a releasable state should also enable us to confidently require documentation for any new features being added as a requirement for that feature being "Done".

      This task consists of many sub-tasks for each part of the public API and examples (there is a second task for the examples themselves, but this task covers the documentation of all examples present currently).

      All public APIs should be be fully documented. That means descriptions of what the class is used for, and each property/method, as well as helpful code snippets where appropriate as well as references to usages in example code.

      In addition there should be an overview page describing the module as whole, and how to use it.

      Also we need to make sure that the documentation is accessable from the global Qt Docs infrastructure (for example qtmodules.html)

      For reference here are the guidelines for writing Qt documentation:
      https://wiki.qt.io/Qt_Writing_Guidelines

        Attachments

        1.
        Document QtQuick3D Light classes Technical task Closed Tomi Korpipää  
        2.
        Document QtQuick3D DefaultMaterial Class Technical task Closed Andy Nichols  
        3.
        Document QtQuick3D PrincipledMaterial class Technical task Closed Christian  
        4.
        Document QtQuick3D Custom Material Components Technical task Closed Antti Määttä  
        5.
        Document QtQuick3D Loader3D component Technical task Closed Andy Nichols  
        6.
        Document QtQuick3D Model Component Technical task Closed Christian  
        7.
        Document QtQuick3D Node Component Technical task Closed Tomi Korpipää  
        8.
        Document QtQuick3D PickResult Component Technical task Closed Jere Tuliniemi  
        9.
        Document QtQuick3D Repeater3D component Technical task Closed Andy Nichols  
        10.
        Document QtQuick3D SceneEnvironment Component Technical task Closed Andy Nichols  
        11.
        Document QtQuick3D Texture Component Technical task Closed Andy Nichols  
        12.
        Document QtQuick3D View3D component Technical task Closed Tomi Korpipää  
        13.
        Provide Overview documentation page for Qt Quick 3D Module Technical task Closed Andy Nichols  
        14.
        Make sure that Qt Quick 3D module is linked to by the Qt Documentation Technical task Closed Tomi Korpipää  
        15.
        Document Qt Quick 3D "Helpers" module Technical task Closed Antti Määttä  
        16.
        Document Qt Quick3D MaterialLibrary Module Technical task Closed Tomi Korpipää  
        17.
        Document which features do and do not work with GLES2 backend Technical task Closed Christian

        0%

        Original Estimate - 3 days
        Remaining Estimate - 3 days
        18.
        Document Qt Quick 3D asset import tool (Balsam) Technical task Closed Andy Nichols  
        19.
        Document Qt Quick3D Asset Conditioning Best Practices Technical task Closed Tomi Korpipää  
        20.
        Document QQuick3DRenderStats class Technical task Closed Jere Tuliniemi  
        21.
        Fix \sa links in Camera Technical task Closed Tomi Korpipää  
        22.
        Fix \sa links in Material Technical task Closed Tomi Korpipää  
        23.
        Fix \sa links in Node Technical task Closed Tomi Korpipää  
        24.
        Fix \sa links in SceneEnvironment Technical task Closed Tomi Korpipää  
        25.
        Fix links in Texture Technical task Closed Tomi Korpipää  
        26.
        Fix links in View3D Technical task Closed Tomi Korpipää  
        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

            Assignee:
            janichol Andy Nichols
            Reporter:
            samakkon Sami Makkonen (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Time Tracking

                Estimated:
                Original Estimate - 1 week, 3 days
                1w 3d
                Remaining:
                Remaining Estimate - 1 week, 3 days
                1w 3d
                Logged:
                Time Spent - Not Specified
                Not Specified

                  Gerrit Reviews

                  There are no open Gerrit changes