From 4ecb016196b80b4cd66759912e20ff1da3d57148 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Thu, 25 May 2023 11:11:54 +0200 Subject: [PATCH] Doc: Add missing \a commands to MacroExpander docs Change-Id: I153e4a4e7c687d6f524bbbff42c758282bb5deaf Reviewed-by: Eike Ziller Reviewed-by: --- src/libs/utils/macroexpander.cpp | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/src/libs/utils/macroexpander.cpp b/src/libs/utils/macroexpander.cpp index 5d3bba0229a..4dc18b23f6b 100644 --- a/src/libs/utils/macroexpander.cpp +++ b/src/libs/utils/macroexpander.cpp @@ -247,7 +247,6 @@ QString MacroExpander::value(const QByteArray &variable, bool *found) const * See the MacroExpander overview documentation for other ways to expand variables. * * \sa MacroExpander - * \sa macroExpander() */ QString MacroExpander::expand(const QString &stringWithVariables) const { @@ -323,10 +322,11 @@ static QByteArray fullPrefix(const QByteArray &prefix) * Makes the given string-valued \a prefix known to the variable manager, * together with a localized \a description. * - * The \a value PrefixFunction will be called and gets the full variable name - * with the prefix stripped as input. + * The \a value \c PrefixFunction will be called and gets the full variable name + * with the prefix stripped as input. It is displayed to users if \a visible is + * \c true. * - * \sa registerVariables(), registerIntVariable(), registerFileVariables() + * \sa registerVariable(), registerIntVariable(), registerFileVariables() */ void MacroExpander::registerPrefix(const QByteArray &prefix, const QString &description, const MacroExpander::PrefixFunction &value, bool visible) @@ -341,6 +341,9 @@ void MacroExpander::registerPrefix(const QByteArray &prefix, const QString &desc * Makes the given string-valued \a variable known to the variable manager, * together with a localized \a description. * + * The \a value \c StringFunction is called to retrieve the current value of the + * variable. It is displayed to users if \a visibleInChooser is \c true. + * * \sa registerFileVariables(), registerIntVariable(), registerPrefix() */ void MacroExpander::registerVariable(const QByteArray &variable, @@ -355,6 +358,9 @@ void MacroExpander::registerVariable(const QByteArray &variable, * Makes the given integral-valued \a variable known to the variable manager, * together with a localized \a description. * + * The \a value \c IntFunction is called to retrieve the current value of the + * variable. + * * \sa registerVariable(), registerFileVariables(), registerPrefix() */ void MacroExpander::registerIntVariable(const QByteArray &variable, @@ -373,6 +379,10 @@ void MacroExpander::registerIntVariable(const QByteArray &variable, * variables such as \c{CurrentDocument:FilePath} with description * "Current Document: Full path including file name." * + * Takes a function that returns a FilePath as a \a base. + * + * The variable is displayed to users if \a visibleInChooser is \c true. + * * \sa registerVariable(), registerIntVariable(), registerPrefix() */ void MacroExpander::registerFileVariables(const QByteArray &prefix,