Статус

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

\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;
}

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

\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)
• ...

\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.