Статус

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

\устаревшее

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

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

\преliminary

Команда \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 отображает это как:

ТипСлияния QChar::joiningType() const

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

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

И запись функции в списке общедоступных функций QChar будет отображена как:

• ...
• ТипСлияния 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.