Статус

Эти команды предназначены для указания специального статуса документированного элемента. Элемент может быть помечен как собирающийся устареть или как не включаемый в публичный интерфейс. Команда \since предназначена для указания номера версии, в которой функция или класс впервые появились. Команда \qmlabstract предназначена для маркировки типа QML как абстрактного базового класса.

\abstract и \qmlabstract

\abstract является синонимом команды \qmlabstract. Добавьте эту команду в комментарий \qmltype для типа QML, когда этот тип предназначен для использования только как абстрактный базовый тип. Когда тип QML является абстрактным, это означает, что тип QML не может быть создан. Вместо этого свойства в его публичном API включаются в список публичных свойств на странице справки для каждого типа QML, наследующего абстрактный тип QML. Свойства документируются так, как если бы они были свойствами наследуемого типа QML.

Обычно, когда тип QML помечается с помощью \qmlabstract, он также помечается с помощью \internal, чтобы страница справки для него не генерировалась. Если абстрактный тип QML не помечен как внутренний, он будет иметь страницу справки в документации.

\default

Команда \default предназначена для маркировки свойства QML как свойства по умолчанию. В документации свойства отображается слово default.

/ *!
    \qmlproperty list<Change> State::changes
    This property holds the changes to apply for this state.
    \default

    By default, these changes are applied against the default state. If the state
    extends another state, then the changes are applied against the state being
    extended.
* /

Посмотрите, как QDoc отображает это свойство на странице справки для типа State.

\dontdocument

Команда \dontdocument используется только в файле dontdocument.qdoc для конкретного модуля. Этот файл определяет публично объявленные классы или структуры, которые не должны быть документированы. QDoc не будет выводить предупреждения об отсутствии комментариев \class для этих классов и структур.

Ниже вы найдете команду \dontdocument в dontdocument.qdoc для виджетов:

/ *!
   \dontdocument (QTypeInfo QMetaTypeId)
* /

\inheaderfile

Метакоманда \inheaderfile используется для переопределения оператора include, сгенерированного для документации ссылок на класс C++, пространство имен или заголовочный файл.

По умолчанию QDoc документирует \class SomeClass как доступный со следующим оператором include:

#include <SomeClass>

Если фактический оператор include отличается от значения по умолчанию, это можно документировать как

\class SomeClass
\inheaderfile Tools/SomeClass
...

См. также \class и \headerfile.

\obsolete

Команда \obsolete используется для указания того, что функция устарела и больше не должна использоваться в новом коде. Нет гарантии, как долго она останется в библиотеке.

Команда \obsolete не принимает аргументов.

При генерации документации справки для класса QDoc создаст и свяжет отдельную страницу, документирующую его устаревшие функции. Обычно в качестве альтернативы предоставляется эквивалентная функция.

/ *!
    \fn MyClass::MyObsoleteFunction
    \obsolete

    Use MyNewFunction() instead.
* /

QDoc отображает это в myclass-obsolete.html как:

Устаревшие члены для MyClass

Следующие члены класса устарели. Они предоставлены для поддержки работы старого кода. Мы настоятельно рекомендуем не использовать их в новом коде.

...

• void MyObsoleteFunction() (obsolete)
• ...

---

Документация по членам-функциям

void MyObsoleteFunction ()

Используйте MyNewFunction() вместо этого.

...

\internal

Команда \internal указывает, что указанная функция не входит в публичный интерфейс.

Команда должна стоять на отдельной строке.

QDoc игнорирует документацию, а также документируемый элемент при генерации связанной документации справки класса.

/ *!
    \internal

    Tries to find the decimal separator. If it can't find
    it and the thousand delimiter is != '.' it will try to
    find a '.';
* /
int QDoubleSpinBoxPrivate::findDelimiter
        (const QString &str, int index) const
{
    int dotindex = str.indexOf(delimiter, index);
    if (dotindex == -1 && thousand != dot && delimiter != dot)
        dotindex = str.indexOf(dot, index);
    return dotindex;
}

Эта функция не будет включена в документацию, если QDoc не вызывается с опцией командной строки -showinternal или переменной окружения QDOC_SHOW_INTERNAL установлена.

\preliminary

Команда \preliminary указывает, что указанная функция все еще находится в стадии разработки.

Команда должна стоять на отдельной строке.

Команда \preliminary добавляет уведомление в документацию функции и помечает функцию как предварительную, когда она появляется в списках.

/ *!
    \preliminary

    Returns information about the joining type attributes of the
    character (needed for certain languages such as Arabic or
    Syriac).

* /
QChar::JoiningType QChar::joiningType() const
{
    return QChar::joiningType(ucs);
}

QDoc отображает это как:

JoiningType QChar::joiningType() const

Эта функция находится в стадии разработки и может быть изменена.

Возвращает информацию о свойствах типа соединения символа (необходимые для некоторых языков, таких как арабский или сирийский).

И запись функции в списке публичных функций QChar отобразится как:

• ...
• JoiningType joiningType() const (preliminary)
• ...

\readonly

Команда \readonly используется совместно с командой \qmlproperty для маркировки свойства QML как только для чтения.

\required

Команда \required используется совместно с командой \qmlproperty для маркировки свойства QML как обязательного.

См. также Систему свойств.

\since

Команда \since указывает, в какой малой версии была добавлена соответствующая функциональность.

/ *!
    \since 4.1

    Returns an icon for \a standardIcon.

    ...

    \sa standardPixmap()
* /
QIcon QStyle::standardIcon(StandardPixmap standardIcon, const QStyleOption *option, const QWidget *widget) const
{
}

QDoc отображает это как:

QIcon QStyle::standardIcon(StandardPixmap standardIcon, const QStyleOption *option, const QWidget *widget) const

Эта функция была представлена в Qt версии 4.1

Возвращает значок для standardIcon.

...

См. также standardPixmap().

QDoc генерирует ссылку "Qt" из переменной конфигурации project. По этой причине эта ссылка будет изменяться в зависимости от текущего проекта документации.

См. также project.