Doc: Add "\inmodule QtCreator" to \class and \namespace docs

To get rid of QDoc warnings.

Change-Id: Idd39b7ae4327798c376f424c94d6617bcaee2258
Reviewed-by: hjk <hjk@qt.io>
This commit is contained in:
Leena Miettinen
2023-05-22 14:38:47 +02:00
parent d8ed764611
commit 8c288bf05f
43 changed files with 67 additions and 9 deletions

View File

@@ -725,6 +725,7 @@ void TaskNode::invokeEndHandler(bool success)
/*! /*!
\namespace Tasking \namespace Tasking
\inmodule QtCreator
The Tasking namespace contains a general purpose TaskTree solution. The Tasking namespace contains a general purpose TaskTree solution.
It depends on Qt only, and doesn't depend on any \QC specific code. It depends on Qt only, and doesn't depend on any \QC specific code.
*/ */

View File

@@ -9,6 +9,7 @@ namespace Utils {
/*! /*!
\class Utils::AnsiEscapeCodeHandler \class Utils::AnsiEscapeCodeHandler
\inmodule QtCreator
\brief The AnsiEscapeCodeHandler class parses text and extracts ANSI escape codes from it. \brief The AnsiEscapeCodeHandler class parses text and extracts ANSI escape codes from it.

View File

@@ -2326,6 +2326,7 @@ void IntegersAspect::setDefaultValue(const QList<int> &value)
/*! /*!
\class Utils::TextDisplay \class Utils::TextDisplay
\inmodule QtCreator
\brief A text display is a phony aspect with the sole purpose of providing \brief A text display is a phony aspect with the sole purpose of providing
some text display using an Utils::InfoLabel in places where otherwise some text display using an Utils::InfoLabel in places where otherwise

View File

@@ -18,6 +18,7 @@
/*! /*!
\class Utils::CheckableMessageBox \class Utils::CheckableMessageBox
\inmodule QtCreator
\brief The CheckableMessageBox class implements a message box suitable for \brief The CheckableMessageBox class implements a message box suitable for
questions with a questions with a

View File

@@ -10,6 +10,7 @@
/*! /*!
\class Utils::ClassNameValidatingLineEdit \class Utils::ClassNameValidatingLineEdit
\inmodule QtCreator
\brief The ClassNameValidatingLineEdit class implements a line edit that \brief The ClassNameValidatingLineEdit class implements a line edit that
validates a C++ class name and emits a signal validates a C++ class name and emits a signal

View File

@@ -41,6 +41,7 @@ namespace Utils {
/*! /*!
\class Utils::ProcessArgs \class Utils::ProcessArgs
\inmodule QtCreator
\brief The ProcessArgs class provides functionality for dealing with \brief The ProcessArgs class provides functionality for dealing with
shell-quoted process arguments. shell-quoted process arguments.
@@ -1398,6 +1399,7 @@ QString ProcessArgs::toString() const
/*! /*!
\class Utils::CommandLine \class Utils::CommandLine
\inmodule QtCreator
\brief The CommandLine class represents a command line of a QProcess or \brief The CommandLine class represents a command line of a QProcess or
similar utility. similar utility.

View File

@@ -13,7 +13,9 @@ static bool isEndOfWordChar(const QChar &c)
return !c.isLetterOrNumber() && c.category() != QChar::Punctuation_Connector; return !c.isLetterOrNumber() && c.category() != QChar::Punctuation_Connector;
} }
/*! \class Utils::CompletingTextEdit /*!
\class Utils::CompletingTextEdit
\inmodule QtCreator
\brief The CompletingTextEdit class is a QTextEdit with auto-completion \brief The CompletingTextEdit class is a QTextEdit with auto-completion
support. support.

View File

@@ -20,6 +20,7 @@
/*! /*!
\class Utils::DetailsWidget \class Utils::DetailsWidget
\inmodule QtCreator
\brief The DetailsWidget class implements a button to expand a \e Details \brief The DetailsWidget class implements a button to expand a \e Details
area. area.

View File

@@ -9,6 +9,7 @@
/*! /*!
\class Utils::ElidingLabel \class Utils::ElidingLabel
\inmodule QtCreator
\brief The ElidingLabel class is a label suitable for displaying elided \brief The ElidingLabel class is a label suitable for displaying elided
text. text.

View File

@@ -8,6 +8,7 @@
/*! /*!
\class Utils::FakeToolTip \class Utils::FakeToolTip
\inmodule QtCreator
\brief The FakeToolTip class is a widget that pretends to be a tooltip. \brief The FakeToolTip class is a widget that pretends to be a tooltip.

View File

@@ -26,6 +26,7 @@
/*! /*!
\class Utils::FancyLineEdit \class Utils::FancyLineEdit
\inmodule QtCreator
\brief The FancyLineEdit class is an enhanced line edit with several \brief The FancyLineEdit class is an enhanced line edit with several
opt-in features. opt-in features.

View File

@@ -311,7 +311,9 @@ void DockWidget::handleToplevelChanged(bool floating)
/*! \class Utils::FancyMainWindow /*!
\class Utils::FancyMainWindow
\inmodule QtCreator
\brief The FancyMainWindow class is a MainWindow with dock widgets and \brief The FancyMainWindow class is a MainWindow with dock widgets and
additional "lock" functionality additional "lock" functionality

View File

@@ -40,6 +40,7 @@ static bool checkPath(const FilePath &candidate, int matchLength,
/*! /*!
\class Utils::FileInProjectFinder \class Utils::FileInProjectFinder
\inmodule QtCreator
\brief The FileInProjectFinder class is a helper class to find the \e original \brief The FileInProjectFinder class is a helper class to find the \e original
file in the project directory for a given file URL. file in the project directory for a given file URL.

View File

@@ -10,6 +10,7 @@
/*! /*!
\class Utils::FileNameValidatingLineEdit \class Utils::FileNameValidatingLineEdit
\inmodule QtCreator
\brief The FileNameValidatingLineEdit class is a control that lets the user \brief The FileNameValidatingLineEdit class is a control that lets the user
choose a (base) file name, based on a QLineEdit. choose a (base) file name, based on a QLineEdit.

View File

@@ -37,7 +37,9 @@ static DeviceFileHooks s_deviceHooks;
inline bool isWindowsDriveLetter(QChar ch); inline bool isWindowsDriveLetter(QChar ch);
/*! \class Utils::FilePath /*!
\class Utils::FilePath
\inmodule QtCreator
\brief The FilePath class is an abstraction for handles to objects \brief The FilePath class is an abstraction for handles to objects
in a (possibly remote) file system, similar to a URL or, in the local in a (possibly remote) file system, similar to a URL or, in the local

View File

@@ -28,6 +28,7 @@ static inline quint64 getFileLimit()
/*! /*!
\class Utils::FileSystemWatcher \class Utils::FileSystemWatcher
\inmodule QtCreator
\brief The FileSystemWatcher class is a file watcher that internally uses \brief The FileSystemWatcher class is a file watcher that internally uses
a centralized QFileSystemWatcher a centralized QFileSystemWatcher
and enforces limits on Mac OS. and enforces limits on Mac OS.

View File

@@ -259,7 +259,9 @@ TempFileSaver::~TempFileSaver()
QFile::remove(m_filePath.toString()); QFile::remove(m_filePath.toString());
} }
/*! \class Utils::FileUtils /*!
\class Utils::FileUtils
\inmodule QtCreator
\brief The FileUtils class contains file and directory related convenience \brief The FileUtils class contains file and directory related convenience
functions. functions.

View File

@@ -8,6 +8,7 @@
/*! /*!
\class Utils::FileWizardPage \class Utils::FileWizardPage
\inmodule QtCreator
\brief The FileWizardPage class is a standard wizard page for a single file \brief The FileWizardPage class is a standard wizard page for a single file
letting the user choose name letting the user choose name

View File

@@ -3,7 +3,9 @@
#include "futuresynchronizer.h" #include "futuresynchronizer.h"
/*! \class Utils::FutureSynchronizer /*!
\class Utils::FutureSynchronizer
\inmodule QtCreator
\brief The FutureSynchronizer is an enhanced version of QFutureSynchronizer. \brief The FutureSynchronizer is an enhanced version of QFutureSynchronizer.
*/ */

View File

@@ -4,7 +4,9 @@
#include "guard.h" #include "guard.h"
#include "qtcassert.h" #include "qtcassert.h"
/*! \class Utils::Guard /*!
\class Utils::Guard
\inmodule QtCreator
\brief The Guard class implements a recursive guard with locking mechanism. \brief The Guard class implements a recursive guard with locking mechanism.

View File

@@ -10,6 +10,7 @@ using namespace Utils;
/*! /*!
\class Utils::HeaderViewStretcher \class Utils::HeaderViewStretcher
\inmodule QtCreator
\brief The HeaderViewStretcher class fixes QHeaderView to resize all \brief The HeaderViewStretcher class fixes QHeaderView to resize all
columns to contents, except one columns to contents, except one

View File

@@ -5,6 +5,7 @@
/*! /*!
\class Utils::TreeView \class Utils::TreeView
\inmodule QtCreator
\brief The TreeView adds setActivationMode to QTreeView \brief The TreeView adds setActivationMode to QTreeView
to allow for single click/double click behavior on to allow for single click/double click behavior on
@@ -15,6 +16,7 @@
/*! /*!
\class Utils::TreeWidget \class Utils::TreeWidget
\inmodule QtCreator
\brief The TreeWidget adds setActivationMode to QTreeWidget \brief The TreeWidget adds setActivationMode to QTreeWidget
to allow for single click/double click behavior on to allow for single click/double click behavior on
@@ -25,6 +27,7 @@
/*! /*!
\class Utils::ListView \class Utils::ListView
\inmodule QtCreator
\brief The ListView adds setActivationMode to QListView \brief The ListView adds setActivationMode to QListView
to allow for single click/double click behavior on to allow for single click/double click behavior on
@@ -35,6 +38,7 @@
/*! /*!
\class Utils::ListWidget \class Utils::ListWidget
\inmodule QtCreator
\brief The ListWidget adds setActivationMode to QListWidget \brief The ListWidget adds setActivationMode to QListWidget
to allow for single click/double click behavior on to allow for single click/double click behavior on

View File

@@ -104,6 +104,7 @@ using namespace Internal;
/*! /*!
\class Utils::MacroExpander \class Utils::MacroExpander
\inmodule QtCreator
\brief The MacroExpander class manages \QC wide variables, that a user \brief The MacroExpander class manages \QC wide variables, that a user
can enter into many string settings. The variables are replaced by an actual value when the string can enter into many string settings. The variables are replaced by an actual value when the string
is used, similar to how environment variables are expanded by a shell. is used, similar to how environment variables are expanded by a shell.

View File

@@ -9,6 +9,7 @@
/*! /*!
\class Utils::NavigationTreeView \class Utils::NavigationTreeView
\inmodule QtCreator
\brief The NavigationTreeView class implements a general TreeView for any \brief The NavigationTreeView class implements a general TreeView for any
sidebar widget. sidebar widget.

View File

@@ -11,6 +11,7 @@ namespace Utils {
/*! /*!
\class Utils::OptionPushButton \class Utils::OptionPushButton
\inmodule QtCreator
\brief The OptionPushButton class implements a QPushButton for which the menu is only opened \brief The OptionPushButton class implements a QPushButton for which the menu is only opened
if the user presses the menu indicator. if the user presses the menu indicator.

View File

@@ -5,6 +5,7 @@
/*! /*!
\class Utils::ParameterAction \class Utils::ParameterAction
\inmodule QtCreator
\brief The ParameterAction class is intended for actions that act on a 'current', \brief The ParameterAction class is intended for actions that act on a 'current',
string-type parameter (typically a file name), for example 'Save file %1'. string-type parameter (typically a file name), for example 'Save file %1'.

View File

@@ -16,6 +16,7 @@
/*! /*!
\class Utils::PathListEditor \class Utils::PathListEditor
\inmodule QtCreator
\brief The PathListEditor class is a control that lets the user edit a list \brief The PathListEditor class is a control that lets the user edit a list
of (directory) paths of (directory) paths

View File

@@ -50,6 +50,7 @@ static QRect stringToRectangle(const QString &v)
/*! /*!
\class Utils::PersistentSettingsReader \class Utils::PersistentSettingsReader
\inmodule QtCreator
\brief The PersistentSettingsReader class reads a QVariantMap of arbitrary, \brief The PersistentSettingsReader class reads a QVariantMap of arbitrary,
nested data structures from an XML file. nested data structures from an XML file.
@@ -349,6 +350,7 @@ FilePath PersistentSettingsReader::filePath()
/*! /*!
\class Utils::PersistentSettingsWriter \class Utils::PersistentSettingsWriter
\inmodule QtCreator
\brief The PersistentSettingsWriter class serializes a QVariantMap of \brief The PersistentSettingsWriter class serializes a QVariantMap of
arbitrary, nested data structures to an XML file. arbitrary, nested data structures to an XML file.

View File

@@ -10,7 +10,9 @@
#include <limits> #include <limits>
/*! \class Utils::Port /*!
\class Utils::Port
\inmodule QtCreator
\brief The Port class implements a wrapper around a 16 bit port number \brief The Port class implements a wrapper around a 16 bit port number
to be used in conjunction with IP addresses. to be used in conjunction with IP addresses.

View File

@@ -1086,6 +1086,7 @@ ProcessResult ProcessPrivate::interpretExitCode(int exitCode)
/*! /*!
\class Utils::Process \class Utils::Process
\inmodule QtCreator
\brief The Process class provides functionality for with processes. \brief The Process class provides functionality for with processes.
@@ -1596,6 +1597,7 @@ QString Process::readAllStandardError()
/*! /*!
\class Utils::SynchronousProcess \class Utils::SynchronousProcess
\inmodule QtCreator
\brief The SynchronousProcess class runs a synchronous process in its own \brief The SynchronousProcess class runs a synchronous process in its own
event loop that blocks only user input events. Thus, it allows for the GUI to event loop that blocks only user input events. Thus, it allows for the GUI to

View File

@@ -7,6 +7,7 @@ namespace Utils {
/*! /*!
\class Utils::ProcessHandle \class Utils::ProcessHandle
\inmodule QtCreator
\brief The ProcessHandle class is a helper class to describe a process. \brief The ProcessHandle class is a helper class to describe a process.
Encapsulates parameters of a running process, local (PID) or remote (to be Encapsulates parameters of a running process, local (PID) or remote (to be

View File

@@ -22,6 +22,7 @@
/*! /*!
\class Utils::ProjectIntroPage \class Utils::ProjectIntroPage
\inmodule QtCreator
\brief The ProjectIntroPage class is the standard wizard page for a project, \brief The ProjectIntroPage class is the standard wizard page for a project,
letting the user choose its name letting the user choose its name

View File

@@ -7,6 +7,7 @@
/*! /*!
\class Utils::StatusLabel \class Utils::StatusLabel
\inmodule QtCreator
\brief The StatusLabel class displays messages for a while with a timeout. \brief The StatusLabel class displays messages for a while with a timeout.
*/ */

View File

@@ -7,6 +7,7 @@ namespace Utils {
/*! /*!
\class Utils::TextFieldCheckBox \class Utils::TextFieldCheckBox
\inmodule QtCreator
\brief The TextFieldCheckBox class is a aheckbox that plays with \brief The TextFieldCheckBox class is a aheckbox that plays with
\c QWizard::registerField. \c QWizard::registerField.

View File

@@ -9,6 +9,7 @@ namespace Utils {
/*! /*!
\class Utils::TextFieldComboBox \class Utils::TextFieldComboBox
\inmodule QtCreator
\brief The TextFieldComboBox class is a non-editable combo box for text \brief The TextFieldComboBox class is a non-editable combo box for text
editing purposes that plays with \c QWizard::registerField (providing a editing purposes that plays with \c QWizard::registerField (providing a
settable 'text' property). settable 'text' property).

View File

@@ -33,6 +33,7 @@ QDebug operator<<(QDebug d, const TextFileFormat &format)
/*! /*!
\class Utils::TextFileFormat \class Utils::TextFileFormat
\inmodule QtCreator
\brief The TextFileFormat class describes the format of a text file and \brief The TextFileFormat class describes the format of a text file and
provides autodetection. provides autodetection.

View File

@@ -895,6 +895,7 @@ void TreeItem::propagateModel(BaseTreeModel *m)
/*! /*!
\class Utils::TreeModel \class Utils::TreeModel
\inmodule QtCreator
\brief The TreeModel class is a convienience base class for models \brief The TreeModel class is a convienience base class for models
to use in a QTreeView. to use in a QTreeView.

View File

@@ -3,6 +3,7 @@
/*! /*!
\namespace Utils \namespace Utils
\inmodule QtCreator
The Utils namespace contains a collection of utility classes and functions for use by all The Utils namespace contains a collection of utility classes and functions for use by all
plugins. plugins.

View File

@@ -23,7 +23,9 @@
#include <QVBoxLayout> #include <QVBoxLayout>
/*! \class Utils::Wizard /*!
\class Utils::Wizard
\inmodule QtCreator
\brief The Wizard class implements a wizard with a progress bar on the left. \brief The Wizard class implements a wizard with a progress bar on the left.

View File

@@ -5,7 +5,9 @@
#include "wizard.h" #include "wizard.h"
/*! \class Utils::WizardPage /*!
\class Utils::WizardPage
\inmodule QtCreator
\brief QWizardPage with a couple of improvements. \brief QWizardPage with a couple of improvements.

View File

@@ -1268,6 +1268,7 @@ LocatorFilterEntries LocatorFileCachePrivate::generate(const QFuture<void> &futu
/*! /*!
\class Core::LocatorFileCache \class Core::LocatorFileCache
\inmodule QtCreator
\brief The LocatorFileCache class encapsulates all the responsibilities needed for \brief The LocatorFileCache class encapsulates all the responsibilities needed for
implementing a cache for file filters. implementing a cache for file filters.

View File

@@ -70,6 +70,7 @@ void ProcessProgressPrivate::parseProgress(const QString &inputText)
/*! /*!
\class Core::ProcessProgress \class Core::ProcessProgress
\inmodule QtCreator
\brief The ProcessProgress class is responsible for showing progress of the running process. \brief The ProcessProgress class is responsible for showing progress of the running process.

View File

@@ -91,6 +91,7 @@ void TaskProgressPrivate::updateProgress()
/*! /*!
\class Core::TaskProgress \class Core::TaskProgress
\inmodule QtCreator
\brief The TaskProgress class is responsible for showing progress of the running task tree. \brief The TaskProgress class is responsible for showing progress of the running task tree.