diff options
| author | Leena Miettinen <[email protected]> | 2013-06-05 14:29:24 +0200 |
|---|---|---|
| committer | Leena Miettinen <[email protected]> | 2013-06-20 11:22:47 +0200 |
| commit | 41411165bac561d3cd93a793c6ae76dcb2937e12 (patch) | |
| tree | cc9e5e516899407448ad8eadd207909ee3115493 /src/plugins | |
| parent | 440725322abf0189c0cb28baddebe76bc26c5f05 (diff) | |
Doc: use standard wording in \brief commands
QDoc does some magic with the \class and \namespaces
and \brief commands, so the following wording must be used:
"The xxx class yyy ..."
Change-Id: Id231f30e8464898b776888d5423523de404aae34
Reviewed-by: Eike Ziller <[email protected]>
Diffstat (limited to 'src/plugins')
100 files changed, 313 insertions, 191 deletions
diff --git a/src/plugins/bineditor/bineditorplugin.cpp b/src/plugins/bineditor/bineditorplugin.cpp index dbfd7e219e4..1d060401433 100644 --- a/src/plugins/bineditor/bineditorplugin.cpp +++ b/src/plugins/bineditor/bineditorplugin.cpp @@ -428,7 +428,8 @@ QStringList BinEditorFactory::mimeTypes() const /*! \class BINEditor::BinEditorWidgetFactory - \brief Service registered with PluginManager to create bin editor widgets for plugins + \brief The BinEditorWidgetFactory class offers a service registered with + PluginManager to create bin editor widgets for plugins without direct linkage. \sa ExtensionSystem::PluginManager::getObjectByClassName, ExtensionSystem::invoke diff --git a/src/plugins/coreplugin/actionmanager/actionmanager.cpp b/src/plugins/coreplugin/actionmanager/actionmanager.cpp index b9d11a1f562..d4ed4f78404 100644 --- a/src/plugins/coreplugin/actionmanager/actionmanager.cpp +++ b/src/plugins/coreplugin/actionmanager/actionmanager.cpp @@ -55,7 +55,7 @@ using namespace Core::Internal; \class Core::ActionManager \mainclass - \brief The action manager is responsible for registration of menus and + \brief The ActionManager class is responsible for registration of menus and menu items and keyboard shortcuts. The ActionManager is the central bookkeeper of actions and their shortcuts and layout. diff --git a/src/plugins/coreplugin/actionmanager/commandbutton.cpp b/src/plugins/coreplugin/actionmanager/commandbutton.cpp index 7176751112a..7f5917aa8b4 100644 --- a/src/plugins/coreplugin/actionmanager/commandbutton.cpp +++ b/src/plugins/coreplugin/actionmanager/commandbutton.cpp @@ -37,7 +37,8 @@ using namespace Core; /*! \class Core::CommandButton - \brief A tool button associated with one of registered Command objects. + \brief The CommandButton class is a tool button associated with one of + the registered Command objects. Tooltip of this button consists of toolTipBase property value and Command's key sequence which is automatically updated when user changes it. diff --git a/src/plugins/coreplugin/basefilewizard.cpp b/src/plugins/coreplugin/basefilewizard.cpp index d0c9d91718f..74d49cef366 100644 --- a/src/plugins/coreplugin/basefilewizard.cpp +++ b/src/plugins/coreplugin/basefilewizard.cpp @@ -100,8 +100,9 @@ void BaseFileWizardParameterData::clear() /*! \class Core::BaseFileWizardParameters - \brief Parameter class for passing parameters to instances of class Wizard - containing name, icon and such. + \brief The BaseFileWizardParameters class is a parameter class for + passing parameters to instances of the class Wizard containing name, icon, + and so on. \sa Core::GeneratedFile, Core::BaseFileWizard, Core::StandardFileWizard \sa Core::Internal::WizardEventLoop @@ -341,7 +342,8 @@ void WizardEventLoop::rejected() /*! \class Core::BaseFileWizard - \brief A generic wizard for creating files. + \brief The BaseFileWizard class implements a generic wizard for + creating files. The abstract methods: \list @@ -781,7 +783,8 @@ QString BaseFileWizard::preferredSuffix(const QString &mimeType) /*! \class Core::StandardFileWizard - \brief Convenience class for creating one file. + \brief The StandardFileWizard class is a convenience class for + creating one file. It uses Utils::FileWizardDialog and introduces a new virtual to generate the files from path and name. diff --git a/src/plugins/coreplugin/dialogs/ioptionspage.cpp b/src/plugins/coreplugin/dialogs/ioptionspage.cpp index db3b8006ca6..34f1de78a2f 100644 --- a/src/plugins/coreplugin/dialogs/ioptionspage.cpp +++ b/src/plugins/coreplugin/dialogs/ioptionspage.cpp @@ -32,7 +32,8 @@ /*! \class Core::IOptionsPage \mainclass - \brief The IOptionsPage is an interface for providing options pages. + \brief The IOptionsPage class is an interface for providing pages for the + \gui Options dialog (called \gui Preferences on Mac OS). You need to subclass this interface and put an instance of your subclass into the plugin manager object pool (e.g. ExtensionSystem::PluginManager::addObject). diff --git a/src/plugins/coreplugin/dialogs/promptoverwritedialog.cpp b/src/plugins/coreplugin/dialogs/promptoverwritedialog.cpp index 9ec8fd9f3d5..bdde354b967 100644 --- a/src/plugins/coreplugin/dialogs/promptoverwritedialog.cpp +++ b/src/plugins/coreplugin/dialogs/promptoverwritedialog.cpp @@ -44,9 +44,11 @@ enum { FileNameRole = Qt::UserRole + 1 }; /*! \class Core::Internal::PromptOverwriteDialog - \brief Prompts the user to overwrite a list of files, which he can check. + \brief The PromptOverwriteDialog class implements a dialog that asks + users whether they want to overwrite files. - Displays the common folder and the files in a checkable list. + The dialog displays the common folder and the files in a list where users + can select the files to overwrite. */ static inline QString fileNameOfItem(const QStandardItem *item) diff --git a/src/plugins/coreplugin/dialogs/readonlyfilesdialog.cpp b/src/plugins/coreplugin/dialogs/readonlyfilesdialog.cpp index 66d86e973ae..18d1e0f10f8 100644 --- a/src/plugins/coreplugin/dialogs/readonlyfilesdialog.cpp +++ b/src/plugins/coreplugin/dialogs/readonlyfilesdialog.cpp @@ -106,7 +106,8 @@ ReadOnlyFilesDialogPrivate::~ReadOnlyFilesDialogPrivate() /*! * \class ReadOnlyFilesDialog - * \brief Dialog to show a set of files which are classified as not writable. + * \brief The ReadOnlyFilesDialog class implements a dialog to show a set of + * files that are classified as not writable. * * Automatically checks which operations are allowed to make the file writable. These operations * are Make Writable which tries to set the file permissions in the file system, diff --git a/src/plugins/coreplugin/documentmanager.cpp b/src/plugins/coreplugin/documentmanager.cpp index 540e2fa7d2b..b39861600c8 100644 --- a/src/plugins/coreplugin/documentmanager.cpp +++ b/src/plugins/coreplugin/documentmanager.cpp @@ -64,7 +64,7 @@ \class Core::DocumentManager \mainclass \inheaderfile documentmanager.h - \brief Manages a set of IDocument objects. + \brief The DocumentManager class manages a set of IDocument objects. The DocumentManager service monitors a set of IDocument's. Plugins should register files they work with at the service. The files the IDocument's point to will be diff --git a/src/plugins/coreplugin/editormanager/ieditor.cpp b/src/plugins/coreplugin/editormanager/ieditor.cpp index d9ad75fe8e7..45ed5897df7 100644 --- a/src/plugins/coreplugin/editormanager/ieditor.cpp +++ b/src/plugins/coreplugin/editormanager/ieditor.cpp @@ -31,7 +31,8 @@ /*! \class Core::IEditor - \brief The IEditor is an interface for providing different editors for different file types. + \brief The IEditor class is an interface for providing different editors for + different file types. Classes that implement this interface are for example the editors for C++ files, ui-files and resource files. diff --git a/src/plugins/coreplugin/editormanager/iexternaleditor.cpp b/src/plugins/coreplugin/editormanager/iexternaleditor.cpp index c1bd9ceeb36..3813c2d3e73 100644 --- a/src/plugins/coreplugin/editormanager/iexternaleditor.cpp +++ b/src/plugins/coreplugin/editormanager/iexternaleditor.cpp @@ -33,8 +33,8 @@ \class Core::IExternalEditor \mainclass - \brief Core::IExternalEditor allows for registering an external - Editor in the \gui{Open With...} dialogs . + \brief The IExternalEditor class enables registering an external + editor in the \gui{Open with} dialog. */ /*! diff --git a/src/plugins/coreplugin/featureprovider.cpp b/src/plugins/coreplugin/featureprovider.cpp index f0b1bde4f5a..d2dd7ffb391 100644 --- a/src/plugins/coreplugin/featureprovider.cpp +++ b/src/plugins/coreplugin/featureprovider.cpp @@ -33,7 +33,8 @@ \class Core::IFeatureProvider \mainclass - \brief The class IFeatureProvider defines an interface to manage features for wizards + \brief The IFeatureProvider class defines an interface to manage features + for wizards. The features provided by an object in the object pool implementing IFeatureProvider will be respected by wizards implementing IWizard. @@ -68,10 +69,8 @@ /*! \class Core::Feature - \brief This class describes a single Feature - - This class describes a single Feature to be used - in Core::FeatureProvider::Features. + \brief The Feature class describes a single feature to be used in + Core::FeatureProvider::Features. \sa Core::FeaturesSet \sa Core::IWizard @@ -81,12 +80,10 @@ /*! \class Core::FeatureSet - \brief This class is a set of features - - Features is used to describe available or - required feature sets and behaves similar to QFlags. + \brief The FeatureSet class is a set of available or required feature sets. - But instead of enums Features relies on string ids + This class behaves similarly to QFlags. However, instead of enums, Features + relies on string ids and is therefore extendable. \sa Core::Feature diff --git a/src/plugins/coreplugin/generatedfile.cpp b/src/plugins/coreplugin/generatedfile.cpp index 3f91be3f1c5..c0616efe797 100644 --- a/src/plugins/coreplugin/generatedfile.cpp +++ b/src/plugins/coreplugin/generatedfile.cpp @@ -40,7 +40,7 @@ namespace Core { /*! \class Core::GeneratedFile - \brief Represents a file generated by a wizard. + \brief The GeneratedFile class represents a file generated by a wizard. The Wizard class will check for each file whether it already exists and will report any errors that may occur during creation of the files. diff --git a/src/plugins/coreplugin/icore.cpp b/src/plugins/coreplugin/icore.cpp index 2a616b592ec..a037646c98f 100644 --- a/src/plugins/coreplugin/icore.cpp +++ b/src/plugins/coreplugin/icore.cpp @@ -47,8 +47,8 @@ /*! \class Core::ICore - \brief The ICore class allows access to the different part that make up - the basic functionality of Qt Creator. + \brief The ICore class allows access to the different parts that make up + the basic functionality of \QC. You should never create a subclass of this interface. The one and only instance is created by the Core plugin. You can access this instance diff --git a/src/plugins/coreplugin/icorelistener.h b/src/plugins/coreplugin/icorelistener.h index fa918c7a2e9..9d29802dc6f 100644 --- a/src/plugins/coreplugin/icorelistener.h +++ b/src/plugins/coreplugin/icorelistener.h @@ -38,8 +38,8 @@ class IEditor; /*! \class Core::ICoreListener - \brief Provides a hook for plugins to veto on certain events emitted from -the core plugin. + \brief The ICoreListener class provides a hook for plugins to veto on certain + events emitted from the core plugin. You implement this interface if you want to prevent certain events from occurring, e.g. if you want to prevent the closing of the whole application diff --git a/src/plugins/coreplugin/id.cpp b/src/plugins/coreplugin/id.cpp index 20a5e218374..8454b427f15 100644 --- a/src/plugins/coreplugin/id.cpp +++ b/src/plugins/coreplugin/id.cpp @@ -43,8 +43,8 @@ namespace Core { /*! \class Core::Id - \brief The class Id encapsulates an identifier that is unique - within a specific running Qt Creator process. + \brief The Id class encapsulates an identifier that is unique + within a specific running \QC process. \c{Core::Id} is used as facility to identify objects of interest in a more typesafe and faster manner than a plain \c QString or diff --git a/src/plugins/coreplugin/mimedatabase.cpp b/src/plugins/coreplugin/mimedatabase.cpp index f8c66a5b249..3d84dbd113c 100644 --- a/src/plugins/coreplugin/mimedatabase.cpp +++ b/src/plugins/coreplugin/mimedatabase.cpp @@ -93,7 +93,8 @@ enum { /*! \class Core::IMagicMatcher - \brief Interface for a Mime type magic matcher (examinig file contents). + \brief The IMagicMatcher class is an interface for a MIME type magic + matcher that examines file contents to determine the MIME type of a file. \sa Core::MimeType, Core::MimeDatabase, Core::MagicRuleMatcher, Core::MagicRule, Core::MagicStringRule, Core::MagicByteRule, Core::GlobPattern \sa Core::Internal::FileMatchContext, Core::Internal::BinaryMatcher, Core::Internal::HeuristicTextMagicMatcher @@ -109,7 +110,8 @@ namespace Internal { /*! \class Core::Internal::FileMatchContext - \brief Context passed on to the mime types when looking for a file match. + \brief The FileMatchContext class is the context passed on to the MIME + types when looking for a file match. It exists to enable reading the file contents "on demand" (as opposed to each mime type trying to open and read while checking). @@ -173,7 +175,8 @@ QByteArray FileMatchContext::data() /*! \class Core::Internal::BinaryMatcher - \brief The binary fallback matcher for mime type "application/octet-stream". + \brief The BinaryMatcher class is the binary fallback matcher for the MIME + type \c{application/octet-stream}. \sa Core::MimeType, Core::MimeDatabase, Core::IMagicMatcher, Core::MagicRuleMatcher, Core::MagicRule, Core::MagicStringRule, Core::MagicByteRule, Core::GlobPattern \sa Core::Internal::FileMatchContext, Core::Internal::HeuristicTextMagicMatcher @@ -190,7 +193,8 @@ public: /*! \class Core::Internal::HeuristicTextMagicMatcher - \brief Heuristic text file matcher for mime types. + \brief The HeuristicTextMagicMatcher class implements a heuristic text file + matcher for MIME types. If the data do not contain any character below tab (9), detect as text. Additionally, check on UTF16 byte order markers. @@ -235,7 +239,8 @@ bool HeuristicTextMagicMatcher::matches(const QByteArray &data) const /*! \class Core::MagicRule - \brief Base class for standard Magic match rules based on contents + \brief The MagicRule class is a base class for standard Magic matching rules + based on contents and offset specification. Stores the offset and provides conversion helpers. @@ -281,7 +286,7 @@ QPair<int, int> MagicRule::fromOffset(const QString &offset) /*! \class Core::MagicStringRule - \brief Match on a string. + \brief The MagicStringRule class provides rules for matching strings. \sa Core::MimeType, Core::MimeDatabase, Core::IMagicMatcher, Core::MagicRuleMatcher, Core::MagicRule, Core::MagicByteRule, Core::GlobPattern \sa Core::Internal::FileMatchContext, Core::Internal::BinaryMatcher, Core::Internal::HeuristicTextMagicMatcher @@ -327,7 +332,8 @@ bool MagicStringRule::matches(const QByteArray &data) const /*! \class Core::MagicByteRule - \brief Match on a sequence of binary data. + \brief The MagicByteRule class provides rules for matching a sequence of + binary data. Format: \code @@ -410,7 +416,8 @@ bool MagicByteRule::matches(const QByteArray &data) const /*! \class Core::MagicRuleMatcher - \brief A Magic matcher that checks a number of rules based on operator "or". + \brief The MagicRuleMatcher class implements a Magic matcher that checks the + number of rules based on the boolean operator OR. It is used for rules parsed from XML files. @@ -474,7 +481,8 @@ IMagicMatcher::IMagicMatcherList MagicRuleMatcher::createMatchers( /*! \class Core::GlobPattern - \brief Glob pattern for file names for mime type matching. + \brief The GlobPattern class provides a glob pattern for file names for + MIME type matching. \sa Core::MimeType, Core::MimeDatabase, Core::IMagicMatcher, Core::MagicRuleMatcher, Core::MagicRule, Core::MagicStringRule, Core::MagicByteRule \sa Core::Internal::FileMatchContext, Core::Internal::BinaryMatcher, Core::Internal::HeuristicTextMagicMatcher @@ -518,7 +526,7 @@ bool MimeGlobPattern::matches(const QString &fileName) const /*! \class Core::MimeType - \brief Mime type data used in Qt Creator. + \brief The MimeType class contains MIME type data used in \QC. Contains most information from standard mime type XML database files. @@ -918,7 +926,8 @@ namespace Internal { /*! \class Core::Internal::BaseMimeTypeParser - \brief Generic parser for a sequence of <mime-type>. + \brief The BaseMimeTypeParser class provides a generic parser for a + sequence of <mime-type>. Calls abstract handler function process for MimeType it finds. @@ -1183,7 +1192,8 @@ MimeMapEntry::MimeMapEntry(const MimeType &t, int aLevel) : /*! \class Core::MimeDatabase - \brief Mime data base to which the plugins can add the mime types they handle. + \brief The MimeDatabase class is a MIME type database to which the plugins + can add the MIME types they handle. The class is protected by a QMutex and can therefore be accessed by threads. @@ -1302,7 +1312,7 @@ MimeDatabasePrivate::MimeDatabasePrivate() : /*! \class Core::Internal::MimeTypeParser - \brief Mime type parser + \brief The MimeTypeParser class provides a MIME type parser. Populates Core::MimeDataBase diff --git a/src/plugins/coreplugin/settingsdatabase.cpp b/src/plugins/coreplugin/settingsdatabase.cpp index ccfaae9b945..c2ca0767830 100644 --- a/src/plugins/coreplugin/settingsdatabase.cpp +++ b/src/plugins/coreplugin/settingsdatabase.cpp @@ -42,7 +42,8 @@ /*! \class Core::SettingsDatabase - \brief An alternative to the application-wide QSettings that is more + \brief The SettingsDatabase class offers an alternative to the + application-wide QSettings that is more suitable for storing large amounts of data. The settings database is SQLite based, and lazily retrieves data when it diff --git a/src/plugins/coreplugin/textdocument.cpp b/src/plugins/coreplugin/textdocument.cpp index f44a86f2b79..c083cf2eb2a 100644 --- a/src/plugins/coreplugin/textdocument.cpp +++ b/src/plugins/coreplugin/textdocument.cpp @@ -35,7 +35,8 @@ /*! \class Core::TextFile - \brief Base class for text files with encoding helpers. + \brief The TextFile class is a base class for text files with encoding + helpers. Stores the format obtained from read operations and uses that when writing out files, thus ensuring that CRLF/encodings are preserved. diff --git a/src/plugins/cpaster/cpasterplugin.cpp b/src/plugins/cpaster/cpasterplugin.cpp index 12102111d1b..5c390070144 100644 --- a/src/plugins/cpaster/cpasterplugin.cpp +++ b/src/plugins/cpaster/cpasterplugin.cpp @@ -69,8 +69,8 @@ namespace CodePaster { /*! \class CodePaster::CodePasterService - \brief Service registered with PluginManager providing CodePaster - post() functionality. + \brief The CodePasterService class is a service registered with PluginManager + that provides CodePaster \c post() functionality. \sa ExtensionSystem::PluginManager::getObjectByClassName, ExtensionSystem::invoke \sa VcsBase::VcsBaseEditorWidget diff --git a/src/plugins/cpptools/cppmodelmanager.cpp b/src/plugins/cpptools/cppmodelmanager.cpp index 71c32abd6f3..1952cdd70ac 100644 --- a/src/plugins/cpptools/cppmodelmanager.cpp +++ b/src/plugins/cpptools/cppmodelmanager.cpp @@ -194,8 +194,8 @@ void CppModelManager::updateModifiedSourceFiles() /*! \class CppTools::CppModelManager - \brief The CppModelManager keeps track of one CppCodeModel instance - for each project and all related CppCodeModelPart instances. + \brief The CppModelManager class keeps track of one CppCodeModel instance + for each project and all the related CppCodeModelPart instances. It also takes care of updating the code models when C++ files are modified within Qt Creator. diff --git a/src/plugins/cpptools/cpppointerdeclarationformatter.h b/src/plugins/cpptools/cpppointerdeclarationformatter.h index e8af400435c..0419f8257ef 100644 --- a/src/plugins/cpptools/cpppointerdeclarationformatter.h +++ b/src/plugins/cpptools/cpppointerdeclarationformatter.h @@ -46,7 +46,8 @@ typedef Utils::ChangeSet::Range Range; /*! \class CppTools::PointerDeclarationFormatter - \brief Rewrite pointer or reference declarations accordingly to an Overview. + \brief The PointerDeclarationFormatter class rewrites pointer or reference + declarations to an Overview. The following constructs are supported: \list diff --git a/src/plugins/debugger/debuggerplugin.cpp b/src/plugins/debugger/debuggerplugin.cpp index 5b5793b426c..334e7b334d2 100644 --- a/src/plugins/debugger/debuggerplugin.cpp +++ b/src/plugins/debugger/debuggerplugin.cpp @@ -154,7 +154,7 @@ /*! \class Debugger::DebuggerEngine - \brief Base class of a debugger engine. + \brief The DebuggerEngine class is the base class of a debugger engine. Note: the Debugger process itself and any helper processes like gdbserver are referred to as 'Engine', whereas the debugged process @@ -322,7 +322,8 @@ sg1: } /*! \class Debugger::Internal::GdbEngine - \brief Implementation of Debugger::Engine driving a gdb executable. + \brief The GdbEngine class implements Debugger::Engine driving a GDB + executable. GdbEngine specific startup. All happens in EngineSetupRequested state: diff --git a/src/plugins/debugger/debuggersourcepathmappingwidget.cpp b/src/plugins/debugger/debuggersourcepathmappingwidget.cpp index 93cbed5375e..5896140b369 100644 --- a/src/plugins/debugger/debuggersourcepathmappingwidget.cpp +++ b/src/plugins/debugger/debuggersourcepathmappingwidget.cpp @@ -68,7 +68,8 @@ typedef DebuggerSourcePathMappingWidget::SourcePathMap SourcePathMap; /*! \class Debugger::Internal::SourcePathMappingModel - \brief Model for DebuggerSourcePathMappingWidget. + \brief The SourcePathMappingModel class is a model for the + DebuggerSourcePathMappingWidget class. Maintains mappings and a dummy placeholder row for adding new mappings. */ @@ -189,7 +190,8 @@ void SourcePathMappingModel::setTarget(int row, const QString &t) /*! \class Debugger::Internal::DebuggerSourcePathMappingWidget - \brief Widget for maintaining a set of source path mappings for the debugger. + \brief The DebuggerSourcePathMappingWidget class is a widget for maintaining + a set of source path mappings for the debugger. Path mappings to be applied using source path substitution in gdb. */ diff --git a/src/plugins/debugger/debuggertooltipmanager.cpp b/src/plugins/debugger/debuggertooltipmanager.cpp index 5237962ef43..75e0a2b7cae 100644 --- a/src/plugins/debugger/debuggertooltipmanager.cpp +++ b/src/plugins/debugger/debuggertooltipmanager.cpp @@ -518,8 +518,11 @@ void DebuggerToolTipWidget::toolButtonClicked() /*! \class Debugger::Internal::DebuggerToolTipContext - File name and position where the tooltip is anchored. Redundant position/line column - information is used to detect if the underlying file has been changed + \brief The DebuggerToolTipContext class specifies the file name and + position where the tooltip is anchored. + + Uses redundant position or line column information to detect whether + the underlying file has been changed on restoring. */ @@ -552,7 +555,10 @@ QDebug operator<<(QDebug d, const DebuggerToolTipContext &c) /*! \class Debugger::Internal::DebuggerToolTipWidget - A debugger tooltip is pinnable. It goes from the unpinned state (button + \brief The DebuggerToolTipWidget class is a pinnable debugger tool tip + widget. + + The debugger tooltip goes from the unpinned state (button showing 'Pin') to the pinned state (button showing 'Close'). It consists of a title toolbar and a vertical main layout. The widget has the ability to save/restore tree model contents to XML. @@ -814,7 +820,8 @@ void DebuggerToolTipWidget::saveSessionData(QXmlStreamWriter &w) const /*! \class Debugger::Internal::TooltipFilterModel - \brief Model for tooltips filtering an item on the watchhandler matching its tree on the iname. + \brief The TooltipFilterModel class is a model for tooltips filtering an + item on the watchhandler matching its tree on the iname. In addition, suppress the model's tooltip data to avoid a tooltip on a tooltip. */ @@ -857,7 +864,8 @@ bool TooltipFilterModel::filterAcceptsRow(int sourceRow, const QModelIndex &sour /*! \class Debugger::Internal::DebuggerToolTipTreeView - A treeview that adapts its size to the model contents (also while expanding) + \brief The DebuggerToolTipTreeView class is a treeview that adapts its size + to the model contents (also while expanding) to be used within DebuggerTreeViewToolTipWidget. */ @@ -1074,7 +1082,8 @@ QString DebuggerToolTipWidget::clipboardContents() const /*! \class Debugger::Internal::DebuggerToolTipManager - Manages the pinned tooltip widgets, listens on editor scroll and main window move + \brief The DebuggerToolTipManager class manages the pinned tooltip widgets, + listens on editor scroll and main window move events and takes care of repositioning the tooltips. Listens to editor change and mode change. In debug mode, if there tooltips diff --git a/src/plugins/debugger/memoryview.cpp b/src/plugins/debugger/memoryview.cpp index a03b3a8976e..38d10d44d42 100644 --- a/src/plugins/debugger/memoryview.cpp +++ b/src/plugins/debugger/memoryview.cpp @@ -41,7 +41,7 @@ namespace Internal { /*! \class Debugger::Internal::MemoryView - \brief Base class for memory view tool windows + \brief The MemoryView class is a base class for memory view tool windows. Small tool-window that stays on top and displays a chunk of memory based on the widget provided by the Bin editor plugin. @@ -121,7 +121,8 @@ void MemoryView::setMarkup(const QList<MemoryMarkup> &m) /*! \class Debugger::Internal::RegisterMemoryView - \brief Memory view that shows the memory around the contents of a register + \brief The RegisterMemoryView class provides a memory view that shows the + memory around the contents of a register (such as stack pointer, program counter), tracking changes of the register value. diff --git a/src/plugins/debugger/snapshothandler.cpp b/src/plugins/debugger/snapshothandler.cpp index ea088f7eaa8..4817de345e9 100644 --- a/src/plugins/debugger/snapshothandler.cpp +++ b/src/plugins/debugger/snapshothandler.cpp @@ -113,7 +113,8 @@ QDebug operator<<(QDebug d, const SnapshotData &f) /*! \class Debugger::Internal::SnapshotHandler - \brief A model to represent the snapshots in a QTreeView. + \brief The SnapshotHandler class provides a model to represent the + snapshots in a QTreeView. A snapshot represents a debugging session. */ diff --git a/src/plugins/debugger/stackhandler.cpp b/src/plugins/debugger/stackhandler.cpp index 18a61f63952..138a6663c9e 100644 --- a/src/plugins/debugger/stackhandler.cpp +++ b/src/plugins/debugger/stackhandler.cpp @@ -49,7 +49,8 @@ namespace Internal { /*! \class Debugger::Internal::StackHandler - \brief A model to represent the stack in a QTreeView. + \brief The StackHandler class provides a model to represent the stack in a + QTreeView. */ StackHandler::StackHandler() diff --git a/src/plugins/debugger/threadshandler.cpp b/src/plugins/debugger/threadshandler.cpp index 19f093f95e1..4f7522e71f8 100644 --- a/src/plugins/debugger/threadshandler.cpp +++ b/src/plugins/debugger/threadshandler.cpp @@ -116,13 +116,17 @@ static QString threadToolTip(const ThreadData &thread) /////////////////////////////////////////////////////////////////////// /*! - \struct Debugger::Internal::ThreadData - \brief A structure containing information about a single thread + \class Debugger::Internal::ThreadData + \internal + \brief The ThreadData class contains information + about a single thread. */ /*! \class Debugger::Internal::ThreadsHandler - \brief A model to represent the running threads in a QTreeView or ComboBox + \internal + \brief The ThreadsHandler class provides a model to + represent the running threads in a QTreeView or ComboBox. */ ThreadsHandler::ThreadsHandler() diff --git a/src/plugins/find/searchresultwindow.cpp b/src/plugins/find/searchresultwindow.cpp index cda06a6464e..12b1181e6ac 100644 --- a/src/plugins/find/searchresultwindow.cpp +++ b/src/plugins/find/searchresultwindow.cpp @@ -201,7 +201,8 @@ using namespace Find::Internal; /*! \class Find::SearchResult - \brief Reports user interaction like activation of a search result item. + \brief The SearchResult class reports user interaction, such as the + activation of a search result item. Whenever a new search is initiated via startNewSearch, an instance of this class is returned to provide the initiator with the hooks for handling user diff --git a/src/plugins/git/branchadddialog.cpp b/src/plugins/git/branchadddialog.cpp index 61b8fb2f184..979b0cdb545 100644 --- a/src/plugins/git/branchadddialog.cpp +++ b/src/plugins/git/branchadddialog.cpp @@ -37,7 +37,8 @@ namespace Git { namespace Internal { /*! - * \brief Validates the corresponding string as a valid git branch name + * \brief The BranchNameValidator class validates the corresponding string as + * a valid Git branch name. * * The class does this by a couple of rules that are applied on the string. * diff --git a/src/plugins/macros/imacrohandler.cpp b/src/plugins/macros/imacrohandler.cpp index 51b7c026423..e0d1a4cfe33 100644 --- a/src/plugins/macros/imacrohandler.cpp +++ b/src/plugins/macros/imacrohandler.cpp @@ -35,7 +35,7 @@ using namespace Macros; /*! \class Macro::IEventHandler - \brief Base class for all macro event handlers. + \brief The IEventHandler class is a base class for all macro event handlers. An event handler is used to handle a specific type of macro events. They are used to create and replay macro events, use MacroManager::registerEventHandler diff --git a/src/plugins/macros/macro.cpp b/src/plugins/macros/macro.cpp index 91a8008afcd..a345f06e208 100644 --- a/src/plugins/macros/macro.cpp +++ b/src/plugins/macros/macro.cpp @@ -41,7 +41,8 @@ using namespace Macros; /*! \class Macros::Macro - \brief Represents a macro, which is more or less a list of Macros::MacroEvent + \brief The Macro class represents a macro, which is more or less a list of + Macros::MacroEvent. A macro is a list of events that can be replayed in Qt Creator. A macro has an header consisting of the Qt Creator version where the macro was created diff --git a/src/plugins/macros/macroevent.cpp b/src/plugins/macros/macroevent.cpp index 1accf695312..9c7aae96da2 100644 --- a/src/plugins/macros/macroevent.cpp +++ b/src/plugins/macros/macroevent.cpp @@ -37,14 +37,13 @@ using namespace Macros; /*! \class Macros::MacroEvent - \brief Represents an event in a macro + \brief The MacroEvent class represents an event in a macro. An event stores information so it can be replayed. An event can be: \list \li menu action \li key event on an editor \li find/replace usage - \li ... \endlist The information are stored in a map of QVariants (using quint8 for keys). diff --git a/src/plugins/macros/macromanager.cpp b/src/plugins/macros/macromanager.cpp index 99ff767af04..002a12427d8 100644 --- a/src/plugins/macros/macromanager.cpp +++ b/src/plugins/macros/macromanager.cpp @@ -67,13 +67,13 @@ using namespace Macros::Internal; /*! \namespace Macros - \brief The Macros namespace contains support for macros in Qt Creator. + \brief The Macros namespace contains support for macros in \QC. */ /*! \class Macro::MacroManager - \brief Manager for macros. + \brief The MacroManager class implements a manager for macros. The MacroManager manage all macros, it loads them on startup, keep track of the current macro and create new macros. diff --git a/src/plugins/projectexplorer/abi.cpp b/src/plugins/projectexplorer/abi.cpp index c9551fbd2fd..f4f484bc725 100644 --- a/src/plugins/projectexplorer/abi.cpp +++ b/src/plugins/projectexplorer/abi.cpp @@ -41,7 +41,8 @@ /*! \class ProjectExplorer::Abi - \brief Represents the Application Binary Interface (ABI) of a target platform. + \brief The Abi class represents the Application Binary Interface (ABI) of + a target platform. \sa ProjectExplorer::ToolChain */ diff --git a/src/plugins/projectexplorer/abiwidget.cpp b/src/plugins/projectexplorer/abiwidget.cpp index 4d5c588bc9b..05d15a211b5 100644 --- a/src/plugins/projectexplorer/abiwidget.cpp +++ b/src/plugins/projectexplorer/abiwidget.cpp @@ -37,7 +37,7 @@ /*! \class ProjectExplorer::AbiWidget - \brief A widget to set an ABI. + \brief The AbiWidget class is a widget to set an ABI. \sa ProjectExplorer::Abi */ diff --git a/src/plugins/projectexplorer/abstractprocessstep.cpp b/src/plugins/projectexplorer/abstractprocessstep.cpp index 2c31d5c61e5..5b0bc84c34b 100644 --- a/src/plugins/projectexplorer/abstractprocessstep.cpp +++ b/src/plugins/projectexplorer/abstractprocessstep.cpp @@ -45,7 +45,8 @@ using namespace ProjectExplorer; /*! \class ProjectExplorer::AbstractProcessStep - \brief A convenience class, which can be used as a base class instead of BuildStep. + \brief The AbstractProcessStep class is a convenience class that can be + used as a base class instead of BuildStep. It should be used as a base class if your buildstep just needs to run a process. diff --git a/src/plugins/projectexplorer/applicationlauncher.cpp b/src/plugins/projectexplorer/applicationlauncher.cpp index 51d87a5fceb..3404b6c2268 100644 --- a/src/plugins/projectexplorer/applicationlauncher.cpp +++ b/src/plugins/projectexplorer/applicationlauncher.cpp @@ -52,7 +52,8 @@ /*! \class ProjectExplorer::ApplicationLauncher - \brief Application launcher of the ProjectExplorer plugin. + \brief The ApplicationLauncher class is the application launcher of the + ProjectExplorer plugin. Encapsulates processes running in a console or as GUI processes, captures debug output of GUI processes on Windows (outputDebugString()). diff --git a/src/plugins/projectexplorer/baseprojectwizarddialog.cpp b/src/plugins/projectexplorer/baseprojectwizarddialog.cpp index cfaf30c94f8..bb4ba350c90 100644 --- a/src/plugins/projectexplorer/baseprojectwizarddialog.cpp +++ b/src/plugins/projectexplorer/baseprojectwizarddialog.cpp @@ -37,7 +37,8 @@ /*! \class ProjectExplorer::BaseProjectWizardDialog - \brief Base class for project wizards. + \brief The BaseProjectWizardDialog class is the base class for project + wizards. Presents the introductory page and takes care of setting the folder chosen as default projects' folder should the user wish to do that. diff --git a/src/plugins/projectexplorer/buildconfigurationmodel.cpp b/src/plugins/projectexplorer/buildconfigurationmodel.cpp index 4d44118d243..8c6a955d614 100644 --- a/src/plugins/projectexplorer/buildconfigurationmodel.cpp +++ b/src/plugins/projectexplorer/buildconfigurationmodel.cpp @@ -35,11 +35,13 @@ using namespace ProjectExplorer; /*! \class ProjectExplorer::BuildConfigurationModel - \brief A model to represent the build configurations of a target. + \brief The BuildConfigurationModel class is a model to represent the build + configurations of a target. To be used in for the drop down of comboboxes. Does automatically adjust itself to added and removed BuildConfigurations Very similar to the Run Configuration Model. + TODO might it possible to share code without making the code a complete mess. */ diff --git a/src/plugins/projectexplorer/buildstep.cpp b/src/plugins/projectexplorer/buildstep.cpp index 2d42b85429c..c39fecac41d 100644 --- a/src/plugins/projectexplorer/buildstep.cpp +++ b/src/plugins/projectexplorer/buildstep.cpp @@ -37,22 +37,24 @@ /*! \class ProjectExplorer::BuildStep - \brief BuildSteps are the primary way plugin developers can customize - how their projects (or projects from other plugins) are build. + \brief The BuildStep class provides build steps for projects. - Building a project, is done by taking the list of buildsteps - from the project and calling first init() than run() on them. + Build steps are the primary way plugin developers can customize + how their projects (or projects from other plugins) are built. - That means to change the way your project is build, reimplemnt - this class and add your Step to the buildStep list of the project. + Projects are built by taking the list of build steps + from the project and calling first \c init() and then \c run() on them. - Note: The projects own the buildstep, do not delete them yourself. + To change the way your project is built, reimplement + this class and add your build step to the build step list of the project. - init() is called in the GUI thread and can be used to query the + \note The projects own the build step. Do not delete them yourself. + + \c init() is called in the GUI thread and can be used to query the project for any information you need. - run() is run via QtConccurrent in a own thread, if you need an - eventloop you need to create it yourself! + \c run() is run via QtConcurrent in a separate thread. If you need an + event loop, you need to create it yourself. */ /*! diff --git a/src/plugins/projectexplorer/customwizard/customwizard.cpp b/src/plugins/projectexplorer/customwizard/customwizard.cpp index 58d6cf6c2a7..cd3c717ffcb 100644 --- a/src/plugins/projectexplorer/customwizard/customwizard.cpp +++ b/src/plugins/projectexplorer/customwizard/customwizard.cpp @@ -54,8 +54,9 @@ namespace ProjectExplorer { /*! \class ProjectExplorer::ICustomWizardFactory - \brief Factory for creating custom wizards extending the base class - (CustomWizard or CustomProjectWizard) + \brief The ICustomWizardFactory class implements a factory for creating + custom wizards extending the base classes: CustomWizard and + CustomProjectWizard. The factory can be registered under a name in CustomWizard. The name can be specified in the \c <wizard class=''...> attribute in the \c wizard.xml file @@ -79,7 +80,8 @@ int CustomWizardPrivate::verbose = 0; /*! \class ProjectExplorer::CustomWizard - \brief Base classes for custom wizards based on file templates and a XML + \brief The CustomWizard class is a base class for custom wizards based on + file templates and an XML configuration file (\c share/qtcreator/templates/wizards). Presents CustomWizardDialog (fields page containing path control) for wizards diff --git a/src/plugins/projectexplorer/customwizard/customwizardpage.cpp b/src/plugins/projectexplorer/customwizard/customwizardpage.cpp index 72ce236fba5..5e847e63b0b 100644 --- a/src/plugins/projectexplorer/customwizard/customwizardpage.cpp +++ b/src/plugins/projectexplorer/customwizard/customwizardpage.cpp @@ -58,8 +58,9 @@ namespace Internal { /*! \class ProjectExplorer::Internal::TextFieldComboBox - \brief A non-editable combo for text editing purposes that plays - with QWizard::registerField (providing a settable 'text' property). + \brief The TextFieldComboBox class is a non-editable combo box for text + editing purposes that plays with \c QWizard::registerField (providing a + settable 'text' property). Allows for a separation of values to be used for wizard fields replacement and display texts. @@ -110,7 +111,8 @@ QString TextFieldComboBox::valueAt(int i) const /*! \class ProjectExplorer::Internal::TextFieldCheckBox - \brief A Checkbox that plays with QWizard::registerField. + \brief The TextFieldCheckBox class is a aheckbox that plays with + \c QWizard::registerField. Provides a settable 'text' property containing predefined strings for 'true'/'false'). @@ -141,7 +143,8 @@ void TextFieldCheckBox::slotStateChanged(int cs) /*! \class ProjectExplorer::Internal::CustomWizardFieldPage - \brief A simple custom wizard page presenting the fields to be used + \brief The CustomWizardFieldPage class is a simple custom wizard page + presenting the fields to be used as page 2 of a BaseProjectWizardDialog if there are any fields. Uses the 'field' functionality of QWizard. diff --git a/src/plugins/projectexplorer/customwizard/customwizardparameters.cpp b/src/plugins/projectexplorer/customwizard/customwizardparameters.cpp index 98badd342cf..c8b8de00644 100644 --- a/src/plugins/projectexplorer/customwizard/customwizardparameters.cpp +++ b/src/plugins/projectexplorer/customwizard/customwizardparameters.cpp @@ -156,7 +156,8 @@ CustomWizardFile::CustomWizardFile() : /*! \class ProjectExplorer::CustomWizardValidationRule - \brief A custom wizard validation rule based on JavaScript-expressions over + \brief The CustomWizardValidationRule class provides a custom wizard + validation rule based on JavaScript-expressions over the field placeholders. Placeholder replacement is performed on the condition and it is evaluated @@ -561,7 +562,8 @@ static inline QString languageSetting() /*! \class ProjectExplorer::Internal::GeneratorScriptArgument - \brief Argument to a custom wizard generator script. + \brief The GeneratorScriptArgument class provides an argument to a custom + wizard generator script. Contains placeholders to be replaced by field values or file names as in \c '--class-name=%ClassName%' or \c '--description=%Description%'. diff --git a/src/plugins/projectexplorer/deployconfigurationmodel.cpp b/src/plugins/projectexplorer/deployconfigurationmodel.cpp index 3e948d3790d..c2c66d4436a 100644 --- a/src/plugins/projectexplorer/deployconfigurationmodel.cpp +++ b/src/plugins/projectexplorer/deployconfigurationmodel.cpp @@ -36,7 +36,8 @@ using namespace ProjectExplorer; /*! \class ProjectExplorer::DeployConfigurationModel - \brief A model to represent the run configurations of a target. + \brief The DeployConfigurationModel class provides a model to represent + the run configurations of a target. To be used in for the drop down of comboboxes. Does automatically adjust itself to added and removed DeployConfigurations diff --git a/src/plugins/projectexplorer/devicesupport/deviceprocessesdialog.cpp b/src/plugins/projectexplorer/devicesupport/deviceprocessesdialog.cpp index 75fc23a031a..47369df4c26 100644 --- a/src/plugins/projectexplorer/devicesupport/deviceprocessesdialog.cpp +++ b/src/plugins/projectexplorer/devicesupport/deviceprocessesdialog.cpp @@ -296,7 +296,7 @@ DeviceProcess DeviceProcessesDialogPrivate::selectedProcess() const /*! \class ProjectExplorer::DeviceProcessesDialog - \brief Shows a list of processes. + \brief The DeviceProcessesDialog class shows a list of processes. The dialog can be used as a \list diff --git a/src/plugins/projectexplorer/devicesupport/idevice.cpp b/src/plugins/projectexplorer/devicesupport/idevice.cpp index 2d121ae173b..3f1941e2843 100644 --- a/src/plugins/projectexplorer/devicesupport/idevice.cpp +++ b/src/plugins/projectexplorer/devicesupport/idevice.cpp @@ -43,7 +43,7 @@ /*! * \class ProjectExplorer::IDevice - * \brief This is the base class for all devices. + * \brief The IDevice class is the base class for all devices. * * The term "device" refers * here to some host to which e.g. files can be deployed or on which an application can run. diff --git a/src/plugins/projectexplorer/ioutputparser.cpp b/src/plugins/projectexplorer/ioutputparser.cpp index fc5882e5f28..a102b6f60c2 100644 --- a/src/plugins/projectexplorer/ioutputparser.cpp +++ b/src/plugins/projectexplorer/ioutputparser.cpp @@ -33,7 +33,8 @@ /*! \class ProjectExplorer::IOutputParser - \brief Interface for an output parser that emit issues (tasks). + \brief The IOutputParser class provides an interface for an output parser + that emits issues (tasks). \sa ProjectExplorer::Task */ diff --git a/src/plugins/projectexplorer/pluginfilefactory.cpp b/src/plugins/projectexplorer/pluginfilefactory.cpp index 86e24a46b2a..64353d644c4 100644 --- a/src/plugins/projectexplorer/pluginfilefactory.cpp +++ b/src/plugins/projectexplorer/pluginfilefactory.cpp @@ -45,7 +45,7 @@ using namespace ProjectExplorer::Internal; /*! \class ProjectExplorer::Internal::ProjectFileFactory - \brief Factory for project files. + \brief The ProjectFileFactory class provides a factory for project files. */ ProjectFileFactory::ProjectFileFactory(IProjectManager *manager) diff --git a/src/plugins/projectexplorer/processparameters.cpp b/src/plugins/projectexplorer/processparameters.cpp index da86fff931e..649225361d7 100644 --- a/src/plugins/projectexplorer/processparameters.cpp +++ b/src/plugins/projectexplorer/processparameters.cpp @@ -38,7 +38,8 @@ /*! \class ProjectExplorer::ProcessParameters - \brief ProcessParameters aggregates all parameters needed to start a process. + \brief The ProcessParameters class aggregates all parameters needed to start + a process. It offers a set of functions which expand macros and environment variables inside the raw parameters to obtain final values for starting a process diff --git a/src/plugins/projectexplorer/project.cpp b/src/plugins/projectexplorer/project.cpp index 9f634eec07c..a66fdc32c12 100644 --- a/src/plugins/projectexplorer/project.cpp +++ b/src/plugins/projectexplorer/project.cpp @@ -45,7 +45,7 @@ /*! \class ProjectExplorer::Project - \brief A project. + \brief The Project class implements a project node in the project explorer. */ /*! diff --git a/src/plugins/projectexplorer/projectexplorer.cpp b/src/plugins/projectexplorer/projectexplorer.cpp index e83723b7daa..73359ffc6ed 100644 --- a/src/plugins/projectexplorer/projectexplorer.cpp +++ b/src/plugins/projectexplorer/projectexplorer.cpp @@ -139,8 +139,8 @@ /*! \class ProjectExplorer::ProjectExplorerPlugin - \brief ProjectExplorerPlugin with static accessor and utility functions to obtain - current project, open projects, etc. + \brief The ProjectExplorerPlugin class contains static accessor and utility + functions to obtain the current project, open projects, and so on. */ namespace { diff --git a/src/plugins/projectexplorer/projectfilewizardextension.cpp b/src/plugins/projectexplorer/projectfilewizardextension.cpp index b1ffbec7ac2..dca5a2c688b 100644 --- a/src/plugins/projectexplorer/projectfilewizardextension.cpp +++ b/src/plugins/projectexplorer/projectfilewizardextension.cpp @@ -64,7 +64,8 @@ /*! \class ProjectExplorer::Internal::ProjectFileWizardExtension - \brief Post-file generating steps of a project wizard. + \brief The ProjectFileWizardExtension class implements the post-file + generating steps of a project wizard. Offers: \list diff --git a/src/plugins/projectexplorer/projectnodes.cpp b/src/plugins/projectexplorer/projectnodes.cpp index 021bbbd211b..3b81a0b498f 100644 --- a/src/plugins/projectexplorer/projectnodes.cpp +++ b/src/plugins/projectexplorer/projectnodes.cpp @@ -49,7 +49,7 @@ using namespace ProjectExplorer; /*! \class ProjectExplorer::Node - \brief Base class of all nodes in the node hierarchy. + \brief The Node class is the base class of all nodes in the node hierarchy. The nodes are arranged in a tree where leaves are FileNodes and non-leaves are FolderNodes A Project is a special Folder that manages the files and normal folders underneath it. diff --git a/src/plugins/projectexplorer/projectwizardpage.cpp b/src/plugins/projectexplorer/projectwizardpage.cpp index d6d4df06311..c8077db03ba 100644 --- a/src/plugins/projectexplorer/projectwizardpage.cpp +++ b/src/plugins/projectexplorer/projectwizardpage.cpp @@ -40,7 +40,8 @@ /*! \class ProjectExplorer::Internal::ProjectWizardPage - \brief Wizard page showing projects and version control to add new files to. + \brief The ProjectWizardPage class provides a wizard page showing projects + and version control to add new files to. \sa ProjectExplorer::Internal::ProjectFileWizardExtension */ diff --git a/src/plugins/projectexplorer/runconfiguration.cpp b/src/plugins/projectexplorer/runconfiguration.cpp index 8f0bf410a9c..45813b206ae 100644 --- a/src/plugins/projectexplorer/runconfiguration.cpp +++ b/src/plugins/projectexplorer/runconfiguration.cpp @@ -64,7 +64,7 @@ const char USE_MULTIPROCESS_KEY[] = "RunConfiguration.UseMultiProcess"; /*! \class ProjectExplorer::ProcessHandle - \brief 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 done, address, port, etc). @@ -115,15 +115,19 @@ RunConfigWidget *IRunConfigurationAspect::createConfigurationWidget() /*! \class ProjectExplorer::RunConfiguration - \brief Base class for a run configuration. A run configuration specifies how a - target should be run, while the runner (see below) does the actual running. + \brief The RunConfiguration class is the base class for a run configuration. - Note that all RunControls and the target hold a shared pointer to the RunConfiguration. - That is the lifetime of the RunConfiguration might exceed the life of the target. + A run configuration specifies how a target should be run, while a runner + does the actual running. + + All RunControls and the target hold a shared pointer to the run + configuration. That is, the lifetime of the run configuration might exceed + the life of the target. The user might still have a RunControl running (or output tab of that RunControl open) and yet unloaded the target. - Also, a RunConfiguration might be already removed from the list of RunConfigurations + Also, a run configuration might be already removed from the list of run + configurations for a target, but still be runnable via the output tab. */ @@ -249,7 +253,8 @@ bool RunConfiguration::fromMap(const QVariantMap &map) /*! \class ProjectExplorer::IRunConfigurationAspect - \brief Extra configuration aspect. + \brief The IRunConfigurationAspect class provides an additional + configuration aspect. Aspects are a mechanism to add RunControl-specific options to a RunConfiguration without subclassing the RunConfiguration for every addition, preventing a combinatorical explosion @@ -277,7 +282,8 @@ Utils::OutputFormatter *RunConfiguration::createOutputFormatter() const /*! \class ProjectExplorer::IRunConfigurationFactory - \brief Restores RunConfigurations from settings. + \brief The IRunConfigurationFactory class restores run configurations from + settings. The run configuration factory is used for restoring run configurations from settings. And used to create new runconfigurations in the "Run Settings" Dialog. @@ -368,7 +374,8 @@ QList<IRunConfigurationFactory *> IRunConfigurationFactory::find(Target *parent) /*! \class ProjectExplorer::IRunControlFactory - \brief Creates RunControl objects matching a RunConfiguration + \brief The IRunControlFactory class creates RunControl objects matching a + run configuration. */ /*! @@ -406,7 +413,7 @@ IRunConfigurationAspect *IRunControlFactory::createRunConfigurationAspect(RunCon /*! \class ProjectExplorer::RunControl - \brief Each instance of this class represents one item that is run. + \brief The RunControl class instances represent one item that is run. */ /*! diff --git a/src/plugins/projectexplorer/runconfigurationmodel.cpp b/src/plugins/projectexplorer/runconfigurationmodel.cpp index 5183206f08f..e9d19e7f363 100644 --- a/src/plugins/projectexplorer/runconfigurationmodel.cpp +++ b/src/plugins/projectexplorer/runconfigurationmodel.cpp @@ -36,7 +36,8 @@ using namespace ProjectExplorer; /*! \class ProjectExplorer::RunConfigurationModel - \brief A model to represent the run configurations of a target. + \brief The RunConfigurationModel class provides a model to represent the + run configurations of a target. To be used in for the drop down of comboboxes. Does automatically adjust itself to added and removed RunConfigurations diff --git a/src/plugins/projectexplorer/session.cpp b/src/plugins/projectexplorer/session.cpp index cb493df4665..8e0dcdea17a 100644 --- a/src/plugins/projectexplorer/session.cpp +++ b/src/plugins/projectexplorer/session.cpp @@ -67,7 +67,7 @@ using namespace ProjectExplorer::Internal; /*! \class ProjectExplorer::SessionManager - \brief Session management. + \brief The SessionManager class manages sessions. TODO the interface of this class is not really great. The implementation suffers that all the functions from the diff --git a/src/plugins/projectexplorer/task.cpp b/src/plugins/projectexplorer/task.cpp index 42db4a143e2..8fb79e097ab 100644 --- a/src/plugins/projectexplorer/task.cpp +++ b/src/plugins/projectexplorer/task.cpp @@ -36,7 +36,7 @@ unsigned int Task::s_nextId = 1; /*! \class ProjectExplorer::Task - \brief Build issue (warning or error). + \brief The Task class represents a build issue (warning or error). \sa ProjectExplorer::TaskHub */ diff --git a/src/plugins/projectexplorer/toolchain.cpp b/src/plugins/projectexplorer/toolchain.cpp index 300812b2ee4..ec532b9df6b 100644 --- a/src/plugins/projectexplorer/toolchain.cpp +++ b/src/plugins/projectexplorer/toolchain.cpp @@ -75,7 +75,7 @@ public: /*! \class ProjectExplorer::ToolChain - \brief Representation of a ToolChain. + \brief The ToolChain class represents a tool chain. \sa ProjectExplorer::ToolChainManager */ diff --git a/src/plugins/projectexplorer/windebuginterface.cpp b/src/plugins/projectexplorer/windebuginterface.cpp index 94f6593c86b..c8b206b6439 100644 --- a/src/plugins/projectexplorer/windebuginterface.cpp +++ b/src/plugins/projectexplorer/windebuginterface.cpp @@ -36,7 +36,8 @@ /*! \class ProjectExplorer::Internal::WinDebugInterface - \brief Windows: Captures output of the Windows API OutputDebugString() function. + \brief The WinDebugInterface class is used on Windows to capture output of + the Windows API \c OutputDebugString() function. Emits output by process id. diff --git a/src/plugins/qmldesigner/designercore/exceptions/exception.cpp b/src/plugins/qmldesigner/designercore/exceptions/exception.cpp index 9951ecd91e7..867f4b25751 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/exception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/exception.cpp @@ -41,8 +41,10 @@ /*! \class QmlDesigner::Exception \ingroup CoreExceptions -\brief This is the abstract base class for all excetions. - Exceptions should be used in cases there is no other way to say something goes wrong. For example +\brief The Exception class is the abstract base class for all exceptions. + + Exceptions should be used if there is no other way to indicate that + something is going wrong. For example, the result would be a inconsistent model or a crash. */ diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp index 742f4859506..b8c79262ca3 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp @@ -33,7 +33,8 @@ /*! \class QmlDesigner::InvalidArgumentException \ingroup CoreExceptions -\brief Exception for a invalid argument +\brief The InvalidArgumentException class provides an exception for an invalid +argument. */ namespace QmlDesigner { diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp index f8e83fae821..c5a9f1d517c 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp @@ -32,7 +32,8 @@ /*! \class QmlDesigner::InvalidMetaInfoException \ingroup CoreExceptions -\brief Exception for a invalid meta info +\brief The InvalidMetaInfoException class provides an exception for invalid meta +info. \see NodeMetaInfo PropertyMetaInfo MetaInfo */ diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp index 5ab1ca09a93..10d1d2426b9 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp @@ -32,7 +32,8 @@ /*! \class QmlDesigner::InvalidModelNodeException \ingroup CoreExceptions -\brief Exception for a invalid model node +\brief The InvalidModelNodeException class provides an exception for an invalid +model node. \see ModelNode */ diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp index 4c5956017f8..7c02df82d35 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp @@ -32,7 +32,8 @@ /*! \class QmlDesigner::InvalidModelStateException \ingroup CoreExceptions -\brief Exception for a invalid model state +\brief The InvalidModelStateException class provides an exception for an +invalid model state. \see ModelState diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp index db7bf6f8480..0f6a850dac8 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp @@ -31,7 +31,8 @@ /*! \class QmlDesigner::InvalidPropertyException \ingroup CoreExceptions -\brief Exception for a invalid property +\brief The InvalidPropertyException class provides an exception for an invalid +property. \see AbstractProperty */ diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp index 6fddef98d8d..f309573cc80 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp @@ -32,7 +32,8 @@ /*! \class QmlDesigner::InvalidQmlSourceException \ingroup CoreExceptions -\brief Exception for invalid qml source code +\brief The InvalidQmlSourceException class provides an exception for invalid QML +source code. */ namespace QmlDesigner { diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp index 2dc3613779f..8184ff308ff 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp @@ -31,7 +31,8 @@ /*! \class QmlDesigner::InvalidReparentingException \ingroup CoreExceptions -\brief Exception for a invalid reparinting + \brief The InvalidReparentingException class provides an exception for + invalid reparenting. \see ModelNode */ diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp index 2de13bd1d99..5989866acac 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp @@ -32,7 +32,8 @@ /*! \class QmlDesigner::InvalidSlideIndexException \ingroup CoreExceptions -\brief Exception for a invalid index for s slide +\brief The InvalidSlideIndexException class provides an exception for an invalid +index for a slide. \see ModelNode */ diff --git a/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp index 2a3972f8675..baa75e07dd6 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp @@ -32,7 +32,8 @@ /*! \class QmlDesigner::ModificationGroupException \ingroup CoreExceptions -\brief Exception for a modification group +\brief The ModificationGroupException class provides an exception for a +modification group. */ namespace QmlDesigner { diff --git a/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp index d637fdc8903..d761903aaae 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp @@ -32,7 +32,8 @@ /*! \class QmlDesigner::RemoveBaseStateException \ingroup CoreExceptions -\brief Exception if you try to remove a BaseState + \brief The RemoveBaseStateException class provides an exception if you try + to remove a BaseState. /see NodeState ModelState */ diff --git a/src/plugins/qmldesigner/designercore/instances/nodeinstanceview.cpp b/src/plugins/qmldesigner/designercore/instances/nodeinstanceview.cpp index 6a920ffffe5..cfed9dd14ca 100644 --- a/src/plugins/qmldesigner/designercore/instances/nodeinstanceview.cpp +++ b/src/plugins/qmldesigner/designercore/instances/nodeinstanceview.cpp @@ -79,7 +79,8 @@ enum { /*! \class QmlDesigner::NodeInstanceView \ingroup CoreInstance -\brief Central class to create and manage instances of a ModelNode. + \brief The NodeInstanceView class is the central class to create and manage + instances of the ModelNode class. This view is used to instance the ModelNodes. Many AbstractViews hold a NodeInstanceView to get values from tghe NodeInstances back. diff --git a/src/plugins/qmldesigner/designercore/metainfo/metainfo.cpp b/src/plugins/qmldesigner/designercore/metainfo/metainfo.cpp index aeb51fc4deb..e6d24377585 100644 --- a/src/plugins/qmldesigner/designercore/metainfo/metainfo.cpp +++ b/src/plugins/qmldesigner/designercore/metainfo/metainfo.cpp @@ -136,7 +136,8 @@ QStringList MetaInfo::s_pluginDirs; /*! \class QmlDesigner::MetaInfo \ingroup CoreModel -\brief The MetaInfo class provides meta information about qml types and properties. +\brief The MetaInfo class provides meta information about QML types and +properties. */ /*! diff --git a/src/plugins/qmldesigner/designercore/model/abstractproperty.cpp b/src/plugins/qmldesigner/designercore/model/abstractproperty.cpp index 9e264747fb2..67cc807d8dc 100644 --- a/src/plugins/qmldesigner/designercore/model/abstractproperty.cpp +++ b/src/plugins/qmldesigner/designercore/model/abstractproperty.cpp @@ -47,7 +47,7 @@ namespace QmlDesigner { /*! \class QmlDesigner::AbstractProperty \ingroup CoreModel -\brief AbstractProperty is a value holder for a property +\brief The AbstractProperty class is a value holder for a property. */ AbstractProperty::AbstractProperty(): diff --git a/src/plugins/qmldesigner/designercore/model/abstractview.cpp b/src/plugins/qmldesigner/designercore/model/abstractview.cpp index b06c07dfca9..68bf75f7f07 100644 --- a/src/plugins/qmldesigner/designercore/model/abstractview.cpp +++ b/src/plugins/qmldesigner/designercore/model/abstractview.cpp @@ -40,7 +40,8 @@ namespace QmlDesigner { /*! \class QmlDesigner::AbstractView \ingroup CoreModel -\brief An abstract interface views and editors can implement to be notified about model changes. +\brief The AbstractView class provides an abstract interface that views and +editors can implement to be notified about model changes. \see QmlDesigner::WidgetQueryView, QmlDesigner::NodeInstanceView */ diff --git a/src/plugins/qmljstools/qmljsbundleprovider.cpp b/src/plugins/qmljstools/qmljsbundleprovider.cpp index 77c0ee03b4b..390618c2bbb 100644 --- a/src/plugins/qmljstools/qmljsbundleprovider.cpp +++ b/src/plugins/qmljstools/qmljsbundleprovider.cpp @@ -47,7 +47,8 @@ typedef QmlJS::QmlLanguageBundles QmlLanguageBundles; /*! \class QmlJSEditor::BasicBundleProvider - \brief a class that sets up the default bundles for qt and various qml states. + \brief The BasicBundleProvider class sets up the default bundles for Qt and + various QML states. */ BasicBundleProvider::BasicBundleProvider(QObject *parent) : IBundleProvider(parent) diff --git a/src/plugins/texteditor/codeassist/iassistinterface.cpp b/src/plugins/texteditor/codeassist/iassistinterface.cpp index 269dcaf6525..dc4e23063b1 100644 --- a/src/plugins/texteditor/codeassist/iassistinterface.cpp +++ b/src/plugins/texteditor/codeassist/iassistinterface.cpp @@ -33,8 +33,8 @@ using namespace TextEditor; /*! \class TextEditor::IAssistInterface - \brief The IAssistInterface class acts as an interface for providing access to the document - from which a proposal is computed. + \brief The IAssistInterface class acts as an interface for providing access + to the document from which a proposal is computed. \ingroup CodeAssist This interface existis in order to avoid a direct dependency on the text editor. This is diff --git a/src/plugins/vcsbase/baseannotationhighlighter.cpp b/src/plugins/vcsbase/baseannotationhighlighter.cpp index 613c2a7b902..3a04647103d 100644 --- a/src/plugins/vcsbase/baseannotationhighlighter.cpp +++ b/src/plugins/vcsbase/baseannotationhighlighter.cpp @@ -39,7 +39,8 @@ typedef QMap<QString, QTextCharFormat> ChangeNumberFormatMap; /*! \class VcsBase::BaseAnnotationHighlighter - \brief Base for a highlighter for annotation lines of the form 'changenumber:XXXX'. + \brief The BaseAnnotationHighlighter class is the base class for a + highlighter for annotation lines of the form 'changenumber:XXXX'. The change numbers are assigned a color gradient. Example: \code diff --git a/src/plugins/vcsbase/basecheckoutwizard.cpp b/src/plugins/vcsbase/basecheckoutwizard.cpp index 84d3e21ffd3..7999c6ea998 100644 --- a/src/plugins/vcsbase/basecheckoutwizard.cpp +++ b/src/plugins/vcsbase/basecheckoutwizard.cpp @@ -42,8 +42,8 @@ /*! \class VcsBase::BaseCheckoutWizard - \brief A Core::IWizard implementing a wizard for initially checking out a project using - a version control system. + \brief The BaseCheckoutWizard class implements a wizard for initially + checking out a project using a version control system. Implements all of Core::IWizard with the exception of name()/description() and icon(). diff --git a/src/plugins/vcsbase/basecheckoutwizardpage.cpp b/src/plugins/vcsbase/basecheckoutwizardpage.cpp index 9091829b269..ec212d9caae 100644 --- a/src/plugins/vcsbase/basecheckoutwizardpage.cpp +++ b/src/plugins/vcsbase/basecheckoutwizardpage.cpp @@ -35,7 +35,8 @@ /*! \class VcsBase::BaseCheckoutWizardPage - \brief Base class for a parameter page of a checkout wizard. + \brief The BaseCheckoutWizardPage class is the base class for a parameter + page of a checkout wizard. Lets the user specify the repository, a checkout directory and the path. Contains a virtual to derive the checkout directory diff --git a/src/plugins/vcsbase/basevcseditorfactory.cpp b/src/plugins/vcsbase/basevcseditorfactory.cpp index 1d1565dee6b..0d2780bf45d 100644 --- a/src/plugins/vcsbase/basevcseditorfactory.cpp +++ b/src/plugins/vcsbase/basevcseditorfactory.cpp @@ -39,7 +39,8 @@ /*! \class VcsBase::BaseVCSEditorFactory - \brief Base class for editor factories creating instances of VcsBaseEditor subclasses. + \brief The BaseVCSEditorFactory class is the base class for editor + factories creating instances of VcsBaseEditor subclasses. \sa VcsBase::VcsBaseEditorWidget */ diff --git a/src/plugins/vcsbase/checkoutjobs.cpp b/src/plugins/vcsbase/checkoutjobs.cpp index 7b618ec625f..6def0ade5f6 100644 --- a/src/plugins/vcsbase/checkoutjobs.cpp +++ b/src/plugins/vcsbase/checkoutjobs.cpp @@ -44,7 +44,9 @@ enum { debug = 0 }; /*! \class VcsBase::AbstractCheckoutJob - \brief Abstract base class for a job creating an initial project checkout. + \brief The AbstractCheckoutJob class is an abstract base class for a job + creating an initial project checkout. + It should be something that runs in the background producing log messages. \sa VcsBase::BaseCheckoutWizard @@ -104,7 +106,8 @@ AbstractCheckoutJob::AbstractCheckoutJob(QObject *parent) : /*! \class VcsBase::ProcessCheckoutJob - \brief Convenience implementation of a VcsBase::AbstractCheckoutJob using a QProcess. + \brief The ProcessCheckoutJob class is a convenience implementation of a + VcsBase::AbstractCheckoutJob using a QProcess. */ ProcessCheckoutJob::ProcessCheckoutJob(QObject *parent) : diff --git a/src/plugins/vcsbase/checkoutprogresswizardpage.cpp b/src/plugins/vcsbase/checkoutprogresswizardpage.cpp index 02be689821d..157b07e1f48 100644 --- a/src/plugins/vcsbase/checkoutprogresswizardpage.cpp +++ b/src/plugins/vcsbase/checkoutprogresswizardpage.cpp @@ -38,8 +38,10 @@ /*! \class VcsBase::CheckoutProgressWizardPage - \brief Page showing the progress of an initial project checkout. Turns complete when the job - succeeds. + \brief The CheckoutProgressWizardPage implements a page showing the + progress of an initial project checkout. + + Turns complete when the job succeeds. \sa VcsBase::BaseCheckoutWizard */ diff --git a/src/plugins/vcsbase/cleandialog.cpp b/src/plugins/vcsbase/cleandialog.cpp index b5366102ae3..73087c0bf47 100644 --- a/src/plugins/vcsbase/cleandialog.cpp +++ b/src/plugins/vcsbase/cleandialog.cpp @@ -144,7 +144,8 @@ CleanDialogPrivate::CleanDialogPrivate() : /*! \class VcsBase::CleanDialog - \brief File selector dialog for files not under version control. + \brief The CleanDialog class provides a file selector dialog for files not + under version control. Completely clean a directory under version control from all files that are not under version control based on a list diff --git a/src/plugins/vcsbase/corelistener.cpp b/src/plugins/vcsbase/corelistener.cpp index cf9d8d2a81d..017d95b6f56 100644 --- a/src/plugins/vcsbase/corelistener.cpp +++ b/src/plugins/vcsbase/corelistener.cpp @@ -33,7 +33,7 @@ /*! \class VcsBase::Internal::CoreListener - \brief CoreListener catching closing of a submit editor. + \brief The CoreListener class catches the closing of a submit editor. Catch the closing of a submit editor to trigger the submit. One instance of this class exists, connected to the instances diff --git a/src/plugins/vcsbase/diffhighlighter.cpp b/src/plugins/vcsbase/diffhighlighter.cpp index 464f399c397..9a26fa5f58e 100644 --- a/src/plugins/vcsbase/diffhighlighter.cpp +++ b/src/plugins/vcsbase/diffhighlighter.cpp @@ -40,7 +40,7 @@ /*! \class VcsBase::DiffHighlighter - \brief A highlighter for diffs. + \brief The DiffHighlighter class provides a highlighter for diffs. Parametrizable by the file indicator, which is for example '^====' in case of p4: \code diff --git a/src/plugins/vcsbase/nicknamedialog.cpp b/src/plugins/vcsbase/nicknamedialog.cpp index 6630da56218..8d64b29701c 100644 --- a/src/plugins/vcsbase/nicknamedialog.cpp +++ b/src/plugins/vcsbase/nicknamedialog.cpp @@ -43,7 +43,7 @@ enum { NickNameRole = Qt::UserRole + 1 }; /*! \class VcsBase::Internal::NickNameDialog - \brief Show users from mail cap file. + \brief The NickNameDialog class shows users from a mail cap file. Manages a list of users read from an extended mail cap file, consisting of 4 columns: "Name Mail [AliasName [AliasMail]]". diff --git a/src/plugins/vcsbase/submiteditorfile.cpp b/src/plugins/vcsbase/submiteditorfile.cpp index 56e21af693f..c07e604c1be 100644 --- a/src/plugins/vcsbase/submiteditorfile.cpp +++ b/src/plugins/vcsbase/submiteditorfile.cpp @@ -35,7 +35,8 @@ using namespace VcsBase::Internal; /*! \class VcsBase::Internal::SubmitEditorFile - \brief A non-saveable IDocument for submit editor files. + \brief The SubmitEditorFile class provides a non-saveable IDocument for + submit editor files. */ SubmitEditorFile::SubmitEditorFile(const QString &mimeType, QObject *parent) : diff --git a/src/plugins/vcsbase/submiteditorwidget.cpp b/src/plugins/vcsbase/submiteditorwidget.cpp index 928a8110f24..192b9d5ccd7 100644 --- a/src/plugins/vcsbase/submiteditorwidget.cpp +++ b/src/plugins/vcsbase/submiteditorwidget.cpp @@ -50,7 +50,8 @@ enum { defaultLineWidth = 72 }; /*! \class VcsBase::SubmitEditorWidget - \brief Presents a VCS commit message in a text editor and a + \brief The SubmitEditorWidget class presents a VCS commit message in a text + editor and a checkable list of modified files in a list window. The user can delete files from the list by unchecking them or diff the selection diff --git a/src/plugins/vcsbase/submitfieldwidget.cpp b/src/plugins/vcsbase/submitfieldwidget.cpp index 61d629e7012..a0df616cf01 100644 --- a/src/plugins/vcsbase/submitfieldwidget.cpp +++ b/src/plugins/vcsbase/submitfieldwidget.cpp @@ -53,7 +53,8 @@ static void inline setComboBlocked(QComboBox *cb, int index) /*! \class VcsBase::SubmitFieldWidget - \brief A widget for editing submit message fields like "reviewed-by:", + \brief The SubmitFieldWidget class is a widget for editing submit message + fields like "reviewed-by:", "signed-off-by:". It displays them in a vertical row of combo/line edit fields diff --git a/src/plugins/vcsbase/submitfilemodel.cpp b/src/plugins/vcsbase/submitfilemodel.cpp index 5c9eee854df..2bc7f75febb 100644 --- a/src/plugins/vcsbase/submitfilemodel.cpp +++ b/src/plugins/vcsbase/submitfilemodel.cpp @@ -70,8 +70,10 @@ static QList<QStandardItem *> createFileRow(const QString &fileName, const QStri /*! \class VcsBase::SubmitFileModel - \brief A 2-column (checkable, state, file name) model to be used to list the files - in the submit editor. Provides header items and a convience to add files. + \brief The SubmitFileModel class is a 2-column (checkable, state, file name) + model to be used to list the files in the submit editor. + + Provides header items and a convenience function to add files. */ SubmitFileModel::SubmitFileModel(QObject *parent) : diff --git a/src/plugins/vcsbase/vcsbaseclient.cpp b/src/plugins/vcsbase/vcsbaseclient.cpp index dfa3acd7d30..e6652842b4b 100644 --- a/src/plugins/vcsbase/vcsbaseclient.cpp +++ b/src/plugins/vcsbase/vcsbaseclient.cpp @@ -55,7 +55,8 @@ /*! \class VcsBase::VcsBaseClient - \brief Base class for Mercurial and Bazaar 'clients'. + \brief The VcsBaseClient class is the base class for Mercurial and Bazaar + 'clients'. Provides base functionality for common commands (diff, log, etc). diff --git a/src/plugins/vcsbase/vcsbaseclientsettings.cpp b/src/plugins/vcsbase/vcsbaseclientsettings.cpp index 5e56da91f58..a5eaae69f54 100644 --- a/src/plugins/vcsbase/vcsbaseclientsettings.cpp +++ b/src/plugins/vcsbase/vcsbaseclientsettings.cpp @@ -184,7 +184,8 @@ public: /*! \class VcsBase::VcsBaseClientSettings - \brief Settings used in VcsBaseClient. + \brief The VcsBaseClientSettings class contains settings used in + VcsBaseClient. \sa VcsBase::VcsBaseClient */ diff --git a/src/plugins/vcsbase/vcsbaseeditor.cpp b/src/plugins/vcsbase/vcsbaseeditor.cpp index 321cca7e32d..247ff8e589f 100644 --- a/src/plugins/vcsbase/vcsbaseeditor.cpp +++ b/src/plugins/vcsbase/vcsbaseeditor.cpp @@ -89,7 +89,8 @@ namespace VcsBase { /*! \class VcsBase::DiffChunk - \brief A diff chunk consisting of file name and chunk data. + \brief The DiffChunk class provides a diff chunk consisting of file name + and chunk data. */ bool DiffChunk::isValid() const @@ -132,7 +133,8 @@ namespace VcsBase { /*! \class VcsBase::VcsBaseEditor - \brief An editor with no support for duplicates. + \brief The VcsBaseEditor class implements an editor with no support for + duplicates. Creates a browse combo in the toolbar for diff output. It also mirrors the signals of the VcsBaseEditor since the editor @@ -173,7 +175,8 @@ VcsBaseEditor::VcsBaseEditor(VcsBaseEditorWidget *widget, namespace Internal { /*! \class AbstractTextCursorHandler - * \brief Provides an interface to handle the contents under a text cursor inside an editor + * \brief The AbstractTextCursorHandler class provides an interface to handle + * the contents under a text cursor inside an editor. */ class AbstractTextCursorHandler : public QObject { @@ -238,7 +241,8 @@ QTextCursor AbstractTextCursorHandler::currentCursor() const } /*! \class ChangeTextCursorHandler - * \brief Provides a handler for VCS change identifiers + * \brief The ChangeTextCursorHandler class provides a handler for VCS change + * identifiers. */ class ChangeTextCursorHandler : public AbstractTextCursorHandler { @@ -368,7 +372,8 @@ QAction *ChangeTextCursorHandler::createCopyRevisionAction(const QString &change } /*! \class UrlTextCursorHandler - * \brief Provides a handler for URL like http://qt-project.org/ + * \brief The UrlTextCursorHandler class provides a handler for URLs, such as + * http://qt-project.org/. * * The URL pattern can be redefined in sub-classes with setUrlPattern(), by default the pattern * works for hyper-text URL @@ -507,7 +512,8 @@ QAction *UrlTextCursorHandler::createCopyUrlAction(const QString &text) const } /*! \class EmailTextCursorHandler - * \brief Provides a handler for email addresses + * \brief The EmailTextCursorHandler class provides a handler for email + * addresses. */ class EmailTextCursorHandler : public UrlTextCursorHandler { @@ -618,10 +624,13 @@ QComboBox *VcsBaseEditorWidgetPrivate::entriesComboBox() } // namespace Internal /*! - \struct VcsBase::VcsBaseEditorParameters + \class VcsBase::VcsBaseEditorParameters - \brief Helper struct used to parametrize an editor with mime type, context - and id. The extension is currently only a suggestion when running + \brief The VcsBaseEditorParameters class is a helper class used to + parametrize an editor with MIME type, context + and id. + + The extension is currently only a suggestion when running VCS commands with redirection. \sa VcsBase::VcsBaseEditorWidget, VcsBase::BaseVcsEditorFactory, VcsBase::EditorContentType @@ -630,7 +639,8 @@ QComboBox *VcsBaseEditorWidgetPrivate::entriesComboBox() /*! \class VcsBase::VcsBaseEditorWidget - \brief Base class for editors showing version control system output + \brief The VcsBaseEditorWidget class is the base class for editors showing + version control system output of the type enumerated by EditorContentType. The source property should contain the file or directory the log diff --git a/src/plugins/vcsbase/vcsbaseeditorparameterwidget.cpp b/src/plugins/vcsbase/vcsbaseeditorparameterwidget.cpp index 1b162d251ff..743feb2cf38 100644 --- a/src/plugins/vcsbase/vcsbaseeditorparameterwidget.cpp +++ b/src/plugins/vcsbase/vcsbaseeditorparameterwidget.cpp @@ -96,7 +96,8 @@ public: /*! \class VcsBase::VcsBaseEditorParameterWidget - \brief A toolbar-like widget for use with VcsBase::VcsBaseEditor::setConfigurationWidget() + \brief The VcsBaseEditorParameterWidget is a toolbar-like widget for use + with VcsBase::VcsBaseEditor::setConfigurationWidget() influencing for example the generation of VCS diff output. The widget maintains a list of command line arguments (starting from baseArguments()) diff --git a/src/plugins/vcsbase/vcsbaseoptionspage.cpp b/src/plugins/vcsbase/vcsbaseoptionspage.cpp index de07fb1e3e0..f6256d0b493 100644 --- a/src/plugins/vcsbase/vcsbaseoptionspage.cpp +++ b/src/plugins/vcsbase/vcsbaseoptionspage.cpp @@ -36,7 +36,8 @@ /*! \class VcsBase::VcsBaseOptionsPage - \brief Base class for VCS options pages providing common category/icon. + \brief The VcsBaseOptionsPage class is the base class for VCS options pages + providing a common category and icon. */ namespace VcsBase { diff --git a/src/plugins/vcsbase/vcsbaseoutputwindow.cpp b/src/plugins/vcsbase/vcsbaseoutputwindow.cpp index 9dd32497ed7..96ced2c7ff0 100644 --- a/src/plugins/vcsbase/vcsbaseoutputwindow.cpp +++ b/src/plugins/vcsbase/vcsbaseoutputwindow.cpp @@ -50,7 +50,8 @@ /*! \class VcsBase::VcsBaseOutputWindow - \brief Output window for Version Control System command and other output (Singleton). + \brief The VcsBaseOutputWindow class is an output window for Version Control + System commands and other output (Singleton). Installed by the base plugin and accessible for the other plugins via static instance()-accessor. Provides slots to append output with diff --git a/src/plugins/vcsbase/vcsbaseplugin.cpp b/src/plugins/vcsbase/vcsbaseplugin.cpp index 05c51a8aa34..3263da69af2 100644 --- a/src/plugins/vcsbase/vcsbaseplugin.cpp +++ b/src/plugins/vcsbase/vcsbaseplugin.cpp @@ -63,12 +63,13 @@ enum { debug = 0, debugRepositorySearch = 0, debugExecution = 0 }; /*! \namespace VcsBase - \brief VcsBase plugin namespace + \brief The VcsBase namespace contains classes for the VcsBase plugin. */ /*! \namespace VcsBase::Internal - \brief Internal namespace of the VcsBase plugin + \brief The Internal namespace contains internal classes for the VcsBase + plugin. \internal */ @@ -76,9 +77,10 @@ namespace VcsBase { namespace Internal { /*! - \struct VcsBase::Internal::State + \class VcsBase::Internal::State - \brief Internal state created by the state listener and VcsBasePluginState. + \brief The State class provides the internal state created by the state + listener and VcsBasePluginState. Aggregated in the QSharedData of VcsBase::VcsBasePluginState. */ @@ -179,7 +181,8 @@ QDebug operator<<(QDebug in, const State &state) /*! \class VcsBase::Internal::StateListener - \brief Connects to the relevant signals of Qt Creator, tries to find version + \brief The StateListener class connects to the relevant signals of \QC, + tries to find version controls and emits signals to the plugin instances. Singleton (as not to do checks multiple times). @@ -305,7 +308,8 @@ public: /*! \class VcsBase::VcsBasePluginState - \brief Relevant state information of the VCS plugins + \brief The VcsBasePluginState class provides relevant state information + about the VCS plugins. Qt Creator's state relevant to VCS plugins is a tuple of @@ -455,7 +459,8 @@ VCSBASE_EXPORT QDebug operator<<(QDebug in, const VcsBasePluginState &state) /*! \class VcsBase::VcsBasePlugin - \brief Base class for all version control plugins. + \brief The VcsBasePlugin class is the base class for all version control + plugins. The plugin connects to the relevant change signals in Qt Creator and calls the virtual diff --git a/src/plugins/vcsbase/vcsbasesubmiteditor.cpp b/src/plugins/vcsbase/vcsbasesubmiteditor.cpp index b4c7e3e2d5c..e8c1cfd1d9e 100644 --- a/src/plugins/vcsbase/vcsbasesubmiteditor.cpp +++ b/src/plugins/vcsbase/vcsbasesubmiteditor.cpp @@ -97,15 +97,17 @@ static const char *belongingClassName(const CPlusPlus::Function *function) } /*! - \struct VcsBase::VcsBaseSubmitEditorParameters + \class VcsBase::VcsBaseSubmitEditorParameters - \brief Utility struct to parametrize a VcsBaseSubmitEditor. + \brief The VcsBaseSubmitEditorParameters class is a utility class + to parametrize a VcsBaseSubmitEditor. */ /*! \class VcsBase::VcsBaseSubmitEditor - \brief Base class for a submit editor based on the SubmitEditorWidget. + \brief The VcsBaseSubmitEditor class is the base class for a submit editor + based on the SubmitEditorWidget. Presents the commit message in a text editor and an checkable list of modified files in a list window. The user can delete |