QDoc Regression Testing

From Qt Wiki
Revision as of 16:10, 25 November 2016 by EdwardWelbourne (talk | contribs) (It's about documentation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

En Ar Bg De El Es Fa Fi Fr Hi Hu It Ja Kn Ko Ms Nl Pl Pt Ru Sq Th Tr Uk Zh

This page outlines a list of pages and functionalities that must be tested for every commit to QDoc. Not all of the items in the list applies and it is up to the commit author and reviewer to decide which test is relevant.

Essential Testing Strategy

This is a list of tests. Testing these pages should be enough to cover most cases.

  1. Compile Code
  2. Look at index.html
  3. Look at the Modules page for links to all essentials and add-ons
  4. Look at All Classes
  5. Look at All QML Types
  6. Look at qtdoc->qtdoc links
  7. Look at qtbase->qtbase links
  8. Look at new module->new module links (qtsensors to qtsensors, for example)
  9. Look at the "5.2" navigation bar
  10. Look at Creator docs or another non-Qt 5 docs
  11. More pages which show obscure edge cases

QML Cases:

  • Item (C++ page, QML type)
  • Button (QML page, QML type)
  • Audio, Sensor, Positioning, other QML types that is outside of qtdeclarative.
  • also possible to test Charts, B2Qt, and Enterprise Controls

There is a separate C++ and QML parser, so these need special attention

C++ Cases:

  • QObject (the inheritance)
  • another class in qtbase (Qt SQL and Qt Network are stable and easy to check)
  • qtdeclarative
  • new module C++ classes

Check the Properties, Functions, grouped properties, inheritance tree. Lots of regression in these areas (missing info, wrong links, and so on).

These cover most of the cases. All do-able for within minutes of clicking around. Check for past regressions (though not all the time).

Specific pages:

index.html (Qt 5 main page)

  1. check for the "Qt Creator" link (link)
  2. check for the "Multimedia" link (qtdoc->qtmultimedia link)
  3. check the list of overviews
  4. check title and the navigation bar and build version

"All Classes" - classes.html

  1. check for new classes such as:
    • QGeoCoordinate (5.2)
    • QSerialPort (5.1)
  2. check for older or special classes:
    • QString (sanity check)
    • QQuickWindow (instantiated by a QML type)
  3. check that A...Z list at the top is correct

"All Modules" - qtmodules.html

  1. check for special modules:
    • ActiveQt (Windows-only but should be built)
    • Qt WebKit (many previous build problems)
    • Qt Bluetooth (new Add-On)
  2. links to the modules should be active

"All QML Types" - qmltypes.html

  1. check for new types such as:
    • Position (5.2)
    • JumpList (5.2)
  2. check for older types such as:
    • Item or Window
    • Button
  3. check that the A...Z list at the top is correct

"All QML APIs by Module" - modules-qml.html

  1. check that the list is correct
    • most modules should be there
    • brief and annotated information
    • title

"All Classes by Module" - modules-cpp.html

  1. check that the list is correct
    • most modules should be there
    • brief and annotated information
    • title

"Item" - qml-qtquick-item.html

  1. HTML filename should be qml-<qmlmodule>-<type>.html
  2. check required information:
    • import statement (same as )
    • instantiates (QQuickItem)
    • inherits: (QtObject)
    • inherited-by: should be reasonably populated
    • clicking on the inherited, instantiated, and other links should work
  3. check Properties section
    • "anchors" is a group and has the members in a sub-list
    • clicking on a property works
  4. check Methods section
    • should look okay
    • "Detailed Description" should look okay:
    • snippets and images look okay
    • "See also" is okay
    • general markup is okay
    • property and method signatures look okay
    • readable and links to the basic type
    • should follow writing guidelines (not necessary for regression testing)

"Button"- qml-qtquick-controls-button.html

  1. HTML filename should be correct
  2. check required information:
    • (see "Item")
    • clicking on inherited-by and inherits should go to the type
  3. check the "List of All Members" page
    • doesn't list private classes and private types

"QSensor Class" - qsensor.html

  1. HTML filename should be correct <classname>.html
  2. check required information:
    • QObject link should work (qtsensors->qtcore link)
    • links to the inherited-by should work (qtsensors->qtsensors link)
    • the fields look okay
  3. check Public Types, Properties, functions, and so on.
    • links should go to the same page
    • return types should be a working link
  4. check the "List of All Members for QSensor" page
    • should look okay

"Qt Positioning QML Types" - qtpositioning-qmlmodule.html

  1. check that the module page lists the QML types
    • title and HTML filename are okay
    • it has QML basic types
    • QML basic type documentation is broken at the moment

"Qt Core C++ Classes" - qtcore-module.html

  1. check that the module page
    • lists the C++ classes and namespace
    • title and HTML filename are correct

"Bluetooth Tennis Example" - qtbluetooth-bttennis-example.html

  1. any other example page is okay too
  2. check that the files are listed
    • title and HTML filename are okay

Miscellaneous Pages and Tests

  1. check for basic style issues:
    • footer and header(should be in every page)
    • HTML title should be correct (QSensors Class | QtSensors 5.2 - Mozilla Firefox)
  2. check "Synchronizing Threads" (threads-synchronizing.html) page for the "next" and "previous" links
    • or check Qt Creator Manual