QMLDocumentationStyle

From Qt Wiki
Revision as of 16:36, 14 January 2015 by Maintenance script (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

QML Documentation Style

This page is part of the Qt Writing Guidelines.

Though there are exceptions, these guidelines should be followed. Keeping that in mind, at least be consistent within the page. Meaning, the class member documentation should have the same style.

QDoc can process QML types defined as C++ classes and QML types defined in .qml files. For C++ classes documented as QML types, the QDoc comments are in the .cpp file while QML types defined in QML are in the .qml file. The C++ classes must also be documented documented with the QML topic commands [doc-snapshot.qt.io]:

For QML types defined in .qml files, QDoc will parse the QML and determine the properties, signals, and the type within the QML definition. The QDoc
block then needs to be immediately above the declaration. For QML types implemented in C++, QDoc will output warnings if the C++ class documentation does not exist.

QML Module Versions

QDoc considers the version specified in the \qmlmodule command as the import statement. Types which belong to the module do not need to specify the version, only the module name.

There are two versions important for the user to know: Qt version and QML module version.

Use

  • “\since 5.3” for \qmltype
  • “\since <qml module> <version>” for \qmlproperty and the members.

“\since QtQuick 2.3” in a property documentation block will generate: “This property was introduced in QtQuick 2.3”

QML Types

The \qmltype [doc-snapshot.qt.io] command is for QML type documentation.

Some commonly used commands and context commands [doc-snapshot.qt.io]:

  • \brief [doc-snapshot.qt.io] – the brief description mandatory
  • \inqmlmodule [doc-snapshot.qt.io] mandatory
  • \instantiates [doc-snapshot.qt.io] – accepts the C++ class which implements the QML type as the argument. For types implemented in QML, this is not needed.
  • \since [doc-snapshot.qt.io] – Add the Qt version the type was introduced in. mandatory (see Note: below about backdating APIs)

Note: It was decided that we will not backdate APIs, so only add the \since with the version number of an upcoming release. See https://codereview.qt.io/#change,43797

The brief description provides a summary for the QML type. The brief does not need to be a complete sentence and may start with a verb. QDoc will append the brief description onto the QML type in tables and generated lists. Don’t forget the period at the end.

Here are some alternate verbs for the brief statement:

  • “Provides…”
  • “Specifies…”
  • “Describes…”

The detailed description follows the brief and may contain images, snippet, and link to other documentation.

Properties

The property description focuses on what the property does. Property documentation usually starts with “This property…” but for certain properties, these are the common expressions:

  • “This property holds…”
  • “This property describes…”
  • “This property represents…”
  • “Returns \c true when… and \c false when…” – for properties that are marked read-only.
  • “Sets the…” – for properties that configure a type.

Aliases

The QDoc parser cannot guess the type of the alias, therefore, the type must be fully documented with the \qmlproperty [doc-snapshot.qt.io] command.

Signals and Handlers Documentation

QML signals are documented either in the QML file or in the C++ implementation with the \qmlsignal [doc-snapshot.qt.io] command. Signal documentation must include the condition for emitting the signal, mention the corresponding signal handler, and document whether the signal accepts a parameter.

These are the possible documentation styles for signals:

  • “This signal is triggered when…”
  • “Triggered when…”
  • “Emitted when…”

Read-Only Properties

To mark that a property is a read-only property, typethe \readonly command in the property documentation. QDoc then notes that the property is a read-only property.

For properties that are declared in QML files with the readonly keyword, QDoc can detect that it is a read-only property and will automatically add the read-only marking.

Methods and JavaScript Functions

Typically, function documentation immediately precedes the implementation of the function in the .cpp file. The topic command [doc-snapshot.qt.io] for functions is \qmlmethod [doc-snapshot.qt.io]. For functions in QML or JavaScript, the documentation must reside immediately above the function declaration.

The function documentation starts with a verb, indicating the operation the function performs.

Some common verbs for function documentation:

  • “Copies…” – for constructors
  • “Destroys…” – for destructors
  • “Returns…” – for accessor functions

The function documentation must document:

  • the return type
  • the parameters
  • the actions of the functions

The \a [doc-snapshot.qt.io] command marks the parameter in the documentation. The return type documentation should link to the type documentation or be marked with the \c [doc-snapshot.qt.io] command in the case of boolean values.

Enumerations

QML enumerations are documented as QML properties with the \qmlproperty [doc-snapshot.qt.io] command. The type of the property is enumeration.

To begin the description, use:

  • “This enumeration…”

The QDoc comment lists the values of the enumeration. If the enumeration is implemented in C++, the documentation may link to the corresponding C++ enumeration. However, the QDoc comment should advise that the enumeration is a C++ enumeration.

Retrieved from "https://wiki.qt.io/index.php?title=QMLDocumentationStyle&oldid=1464"