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

qt QML documentation lacks either links or preferably gentler language recitation of API reference instructions for standard JavaScript objects,where applicable.

    XMLWordPrintable

Details

    Description

      As the Qt documentation should be used as one stop shop for qt capabilities, where applicable, the docs should include links or preferably recite in lighter language the API reference / instructions for objects that QML has as being a JavaScript compliant runtime (Qt global objects).

      One such example is that XMLHttpRequest object does support HTTP auth programatically as in JavaScript but this is no where to be seen on whole of Qt docs, and there is not an example to illustrate it.

      Moreover, checking the W3C docs is not trivial at all if you just want to finish a task of implementing a HTTP Auth enabled QML app, as you need to read through http://www.w3.org/TR/XMLHttpRequest/ which is far from a user friendly documentation style (IMHO).

      Attachments

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

        Activity

          People

            docteam Qt Documentation Team
            sivang Sivan Greenberg
            Votes:
            1 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes