Relier les choses
Les commandes de mise en relation permettent de spécifier comment un élément documenté est lié à un autre élément documenté. Quelques exemples :
- Cette fonction est une surcharge d'une autre fonction.
- Cette fonction est une réimplémentation d'une autre fonction.
- Ce typedef est lié à une classe ou à un fichier d'en-tête.
Il existe également une commande permettant de documenter le fait qu'un type QML hérite d'un autre type QML.
Commandes
\Héritage
La commande \inherits permet de documenter le fait qu'un type QML hérite d'un autre type QML. Elle doit être incluse dans le commentaire \qmltype de l'élément héritant. L'argument est le nom du type QML hérité.
/*!
\qmltype PauseAnimation
\nativetype QDeclarativePauseAnimation
\ingroup qml-animation-transition
\since 4.7
\inherits Animation
\brief The PauseAnimation element provides a pause for an animation.
When used in a SequentialAnimation, PauseAnimation is a step
when nothing happens, for a specified duration.
A 500ms animation sequence, with a 100ms pause between two animations:
SequentialAnimation {
NumberAnimation { ... duration: 200 }
PauseAnimation { duration: 100 }
NumberAnimation { ... duration: 200 }
}
\sa {QML Animation and Transitions}, {declarative/animation/basics}{Animation basics example}
*/QDoc inclut cette ligne dans la page de référence de l'élément PauseAnimation:
Hérite Animation
\overload
La commande \overload permet d'indiquer qu'une fonction est une surcharge secondaire de son nom. La commande doit être placée sur sa propre ligne. Si la commande est utilisée avec une fonction qui n'est pas une surcharge réelle, elle est considérée comme nulle.
Pour un nom de fonction surchargé (à l'exception des constructeurs), QDoc s'attend à une version primaire de la fonction et à toutes les autres marquées par la commande\overload. La version primaire doit être entièrement documentée. Chaque surcharge peut avoir la documentation supplémentaire que vous souhaitez ajouter pour cette seule version surchargée.
Vous pouvez inclure le nom de la fonction plus '()' en tant que paramètre de la commande \overload, qui inclura une ligne de texte standard This function overloads... avec un lien vers la documentation de la version primaire de la fonction. Vous pouvez utiliser un nom pleinement qualifié (tel que QMenu::addAction()) ou un nom non qualifié (tel que addAction()). Lorsque vous utilisez un nom de fonction non qualifié, QDoc le qualifie automatiquement en utilisant le nom de la classe ou de l'espace de noms parent. Par exemple, addAction() devient QMenu::addAction() lorsqu'il est utilisé dans la documentation de la classe QMenu.
/*!
\overload addAction()
This convenience function creates a new action with an
\a icon and some \a text. The function adds the newly
created action to the menu's list of actions, and
returns it.
\sa QWidget::addAction()
*/
QAction *QMenu::addAction(const QIcon &icon, const QString &text)
{
QAction *ret = new QAction(icon, text, this);
addAction(ret);
return ret;
}Si vous n'incluez pas le nom de la fonction avec la commande \overload, au lieu de la ligne "Cette fonction surcharge..." avec le lien vers la documentation de la version primaire, vous obtenez l'ancienne ligne standard :
Ceci est une fonction membre surchargée, fournie pour des raisons de commodité.
.
\reimp
La commande \reimp permet d'indiquer qu'une fonction est une réimplémentation d'une fonction virtuelle sans nécessiter de documentation supplémentaire.
Par défaut, QDoc omettra une fonction virtuelle réimplémentée de la référence de la classe à moins qu'elle ne soit documentée. Cette commande permet de s'assurer qu'une fonction non documentée sera incluse.
La commande doit être placée sur sa propre ligne.
/*!
\reimp
*/
void QToolButton::nextCheckState()
{
Q_D(QToolButton);
if (!d->defaultAction)
QAbstractButton::nextCheckState();
else
d->defaultAction->trigger();
}Cette fonction ne sera pas incluse dans la documentation. À la place, un lien vers la fonction de base QAbstractButton::nextCheckState() apparaîtra dans la documentation.
\Relation
La commande \relates permet d'inclure la documentation d'une entité (fonction, macro, typedef, enum ou variable) dans une classe, un espace de noms ou un fichier d'en-tête. L'argument est le nom de la classe, de l'espace de noms ou de l'en-tête auquel l'entité est liée.
Si l'argument fait référence à un type modélisé, utilisez uniquement le nom du type (sans les paramètres de modélisation).
/*!
\relates QChar
Reads a char from the stream \a in into char \a chr.
\sa {Format of the QDataStream operators}
*/
QDataStream &operator>>(QDataStream &in, QChar &chr)
{
quint16 u;
in >> u;
chr.unicode() = ushort(u);
return in;
}La documentation de cette fonction est incluse dans la page de référence de la classe QChar, listée dans la section Related Non-members.
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.