Статус

Эти команды предназначены для указания специального статуса документированного элемента. Элемент может быть помечен как устаревающий или как просто не включённый в публичный интерфейс. Команда \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.

\устаревший

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

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

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

/ *!
    \fn MyClass::MyObsoleteFunction
    \obsolete

    Use MyNewFunction() instead.
* /

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

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

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

...

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

---

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

void MyObsoleteFunction ()

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

...

\внутренний

Команда \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;
}

Эта функция не будет включена в документацию.

\предварительный

Команда \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)
• ...

\с

Команда \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.