diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2020-03-18 13:32:02 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2020-03-18 13:39:43 +0000 |
commit | eecd2a5aa11308a62668a85027c1bb9f82e5a108 (patch) | |
tree | 96809390ced0ef2d21ff9936fa49fd899af6256e | |
parent | b4a9801f0558490f6863dfdd41a1b01395ec1753 (diff) |
Doc: Fix QDoc warnings in Core plugin classes
Task-number: QTCREATORBUG-23620
Change-Id: Idf1fb2b3f930812c3cf18b9f8ced03fb8e0947be
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
-rw-r--r-- | src/plugins/coreplugin/featureprovider.cpp | 3 | ||||
-rw-r--r-- | src/plugins/coreplugin/fileiconprovider.cpp | 26 | ||||
-rw-r--r-- | src/plugins/coreplugin/generatedfile.cpp | 6 | ||||
-rw-r--r-- | src/plugins/coreplugin/icontext.cpp | 10 | ||||
-rw-r--r-- | src/plugins/coreplugin/icore.cpp | 339 | ||||
-rw-r--r-- | src/plugins/coreplugin/id.cpp | 9 | ||||
-rw-r--r-- | src/plugins/coreplugin/idocument.cpp | 28 | ||||
-rw-r--r-- | src/plugins/coreplugin/inavigationwidgetfactory.cpp | 4 | ||||
-rw-r--r-- | src/plugins/coreplugin/ioutputpane.cpp | 14 | ||||
-rw-r--r-- | src/plugins/coreplugin/mainwindow.cpp | 6 | ||||
-rw-r--r-- | src/plugins/coreplugin/minisplitter.cpp | 24 | ||||
-rw-r--r-- | src/plugins/coreplugin/modemanager.cpp | 10 | ||||
-rw-r--r-- | src/plugins/coreplugin/settingsdatabase.cpp | 1 | ||||
-rw-r--r-- | src/plugins/coreplugin/statusbarmanager.cpp | 2 | ||||
-rw-r--r-- | src/plugins/coreplugin/textdocument.cpp | 42 |
15 files changed, 259 insertions, 265 deletions
diff --git a/src/plugins/coreplugin/featureprovider.cpp b/src/plugins/coreplugin/featureprovider.cpp index 6879480dca..ac0acba8b7 100644 --- a/src/plugins/coreplugin/featureprovider.cpp +++ b/src/plugins/coreplugin/featureprovider.cpp @@ -27,7 +27,8 @@ /*! \class Core::IFeatureProvider - \mainclass + \inmodule QtCreator + \ingroup mainclasses \brief The IFeatureProvider class defines an interface to manage features for wizards. diff --git a/src/plugins/coreplugin/fileiconprovider.cpp b/src/plugins/coreplugin/fileiconprovider.cpp index ea52978784..8ce3bce56f 100644 --- a/src/plugins/coreplugin/fileiconprovider.cpp +++ b/src/plugins/coreplugin/fileiconprovider.cpp @@ -44,15 +44,18 @@ using namespace Utils; /*! - \class Core::FileIconProvider + \namespace Core::FileIconProvider + \inmodule QtCreator + \brief Provides functions for registering custom overlay icons for system + icons. Provides icons based on file suffixes with the ability to overwrite system icons for specific subtypes. The underlying QFileIconProvider can be used for QFileSystemModel. - Note: Registering overlay icons currently completely replaces the system + \note Registering overlay icons currently completely replaces the system icon and is therefore not recommended on platforms that have their - own overlay icon handling (Mac/Windows). + own overlay icon handling (\macOS and Windows). Plugins can register custom overlay icons via registerIconOverlayForSuffix(), and retrieve icons via the icon() function. @@ -169,7 +172,7 @@ QIcon FileIconProviderImplementation::icon(const QFileInfo &fileInfo) const } /*! - Returns the icon associated with the file suffix in fileInfo. If there is none, + Returns the icon associated with the file suffix in \a info. If there is none, the default icon of the operating system is returned. */ @@ -187,8 +190,7 @@ QIcon icon(QFileIconProvider::IconType type) } /*! - Creates a pixmap with baseicon and overlays overlayIcon over it. - See platform note in class documentation about recommended usage. + Creates a pixmap with \a baseIcon and lays \a overlayIcon over it. */ QPixmap overlayIcon(const QPixmap &baseIcon, const QIcon &overlayIcon) { @@ -199,8 +201,7 @@ QPixmap overlayIcon(const QPixmap &baseIcon, const QIcon &overlayIcon) } /*! - Creates a pixmap with baseicon at size and overlays overlayIcon over it. - See platform note in class documentation about recommended usage. + Creates a pixmap with \a baseIcon at \a size and \a overlay. */ QPixmap overlayIcon(QStyle::StandardPixmap baseIcon, const QIcon &overlay, const QSize &size) { @@ -208,16 +209,17 @@ QPixmap overlayIcon(QStyle::StandardPixmap baseIcon, const QIcon &overlay, const } /*! - Registers an icon for a given suffix, overlaying the system file icon. - See platform note in class documentation about recommended usage. - */ + Registers an icon at \a path for a given \a suffix, overlaying the system + file icon. + */ void registerIconOverlayForSuffix(const QString &path, const QString &suffix) { instance()->registerIconOverlayForSuffix(path, suffix); } /*! - Registers an icon for all the suffixes of a given mime type, overlaying the system file icon. + Registers \a icon for all the suffixes of a the mime type \a mimeType, + overlaying the system file icon. */ void registerIconOverlayForMimeType(const QIcon &icon, const QString &mimeType) { diff --git a/src/plugins/coreplugin/generatedfile.cpp b/src/plugins/coreplugin/generatedfile.cpp index 5d009087db..004b5bbb83 100644 --- a/src/plugins/coreplugin/generatedfile.cpp +++ b/src/plugins/coreplugin/generatedfile.cpp @@ -38,13 +38,13 @@ namespace Core { /*! \class Core::GeneratedFile + \inmodule QtCreator \brief The GeneratedFile class represents a file generated by a wizard. - The Wizard class checks whether each file already exists and + The BaseFileWizard class checks whether each file already exists and reports any errors that may occur during creation of the files. - \sa Core::BaseFileWizardParameters, Core::BaseFileWizard, Core::StandardFileWizard - \sa Core::Internal::WizardEventLoop + \sa Core::WizardDialogParameters, Core::BaseFileWizard, */ diff --git a/src/plugins/coreplugin/icontext.cpp b/src/plugins/coreplugin/icontext.cpp index 64f6e869ed..a0838e707f 100644 --- a/src/plugins/coreplugin/icontext.cpp +++ b/src/plugins/coreplugin/icontext.cpp @@ -44,3 +44,13 @@ QDebug operator<<(QDebug debug, const Core::Context &context) return debug; } + +/*! + \class Core::IContext + \inmodule QtCreator + \ingroup mainclasses + \brief The IContext class holds the context for performing an action. + + The behavior of some actions depends on the context in which they are + applied. +*/ diff --git a/src/plugins/coreplugin/icore.cpp b/src/plugins/coreplugin/icore.cpp index ead03010eb..2ab0936300 100644 --- a/src/plugins/coreplugin/icore.cpp +++ b/src/plugins/coreplugin/icore.cpp @@ -40,6 +40,7 @@ /*! \namespace Core + \inmodule QtCreator \brief The Core namespace contains all classes that make up the Core plugin which constitute the basic functionality of \QC. */ @@ -68,219 +69,30 @@ /*! \class Core::ICore \inmodule QtCreator + \ingroup mainclasses \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 - from your plugin through \c{Core::instance()}. - - \ingroup mainclasses -*/ - -/*! - \fn void ICore::showNewItemDialog(const QString &title, - const QList<IWizard *> &wizards, - const QString &defaultLocation = QString(), - const QVariantMap &extraVariables = QVariantMap()) - - Opens a dialog where the user can choose from a set of \a wizards that - create new files, classes, or projects. - - The \a title argument is shown as the dialog title. The path where the - files will be created (if the user does not change it) is set - in \a defaultLocation. It defaults to the path of the file manager's - current file. - - \sa Core::DocumentManager -*/ - -/*! - \fn bool ICore::showOptionsDialog(Id group, Id page, QWidget *parent = 0); - - Opens the application \uicontrol Options (or \uicontrol Preferences) dialog with preselected - \a page in the specified \a group. - - The arguments refer to the string IDs of the corresponding IOptionsPage. -*/ - -/*! - \fn bool ICore::showWarningWithOptions(const QString &title, const QString &text, - const QString &details = QString(), - Id settingsCategory = Id(), - Id settingsId = Id(), - QWidget *parent = 0) - - Shows a warning message with a button that opens a settings page. - - Should be used to display configuration errors and point users to the setting. - Returns \c true if the settings dialog was accepted. -*/ - - -/*! - \fn QSettings *ICore::settings(QSettings::Scope scope = QSettings::UserScope) - - Returns the application's main settings object. - - You can use it to retrieve or set application wide settings - (in contrast to session or project specific settings). - - If \a scope is \c QSettings::UserScope (the default), the - users settings will be read from the users settings, with - a fallback to global settings provided with \QC. - - If \a scope is \c QSettings::SystemScope, only the system settings - shipped with the current version of \QC will be read. This - functionality exists for internal purposes only. - - \see settingsDatabase() -*/ - -/*! - \fn SettingsDatabase *ICore::settingsDatabase() - - Returns the application's settings database. - - The settings database is meant as an alternative to the regular settings - object. It is more suitable for storing large amounts of data. The settings - are application wide. - - \see SettingsDatabase -*/ - -/*! - \fn QPrinter *ICore::printer() - - Returns the application's printer object. - - Always use this printer object for printing, so the different parts of the - application re-use its settings. -*/ - -/*! - \fn QString ICore::resourcePath() - - Returns the absolute path that is used for resources like - project templates and the debugger macros. - - This abstraction is needed to avoid platform-specific code all over - the place, since on Mac OS X, for example, the resources are part of the - application bundle. -*/ - - -/*! - \fn QString ICore::userResourcePath() - - Returns the absolute path in the users directory that is used for - resources like project templates. - - Use this function for finding the place for resources that the user may - write to, for example, to allow for custom palettes or templates. -*/ - -/*! - \fn QWidget *ICore::mainWindow() - - Returns the main application window. - - For dialog parents use \c dialogParent(). -*/ - -/*! - \fn QWidget *ICore::dialogParent() - - Returns a widget pointer suitable to use as parent for QDialogs. - */ - -/*! - \fn IContext *ICore::currentContextObject() - - Returns the context object of the current main context. - - \sa ICore::updateAdditionalContexts() - \sa ICore::addContextObject() -*/ - -/*! - \fn void ICore::updateAdditionalContexts(const Context &remove, const Context &add) - Changes the currently active additional contexts. - - Removes the list of additional contexts specified by \a remove and adds the - list of additional contexts specified by \a add. - - \sa ICore::hasContext() -*/ - -/*! - \fn bool ICore::hasContext(int context) const - Returns whether the given \a context is currently one of the active contexts. - - \sa ICore::updateAdditionalContexts() - \sa ICore::addContextObject() -*/ - -/*! - \fn void ICore::addContextObject(IContext *context) - Registers an additional \a context object. - - After registration this context object gets automatically the - current context object whenever its widget gets focus. - - \sa ICore::removeContextObject() - \sa ICore::updateAdditionalContexts() - \sa ICore::currentContextObject() -*/ - -/*! - \fn void ICore::removeContextObject(IContext *context) - Unregisters a \a context object from the list of know contexts. - - \sa ICore::addContextObject() - \sa ICore::updateAdditionalContexts() - \sa ICore::currentContextObject() -} -*/ - -/*! - \fn void ICore::openFiles(const QStringList &fileNames, OpenFilesFlags flags = None) - Opens all files from a list of \a fileNames like it would be - done if they were given to \QC on the command line, or - they were opened via \uicontrol File > \uicontrol Open. -*/ - -/*! - \fn ICore::ICore(Internal::MainWindow *mw) - \internal -*/ - -/*! - \fn ICore::~ICore() - \internal + from your plugin through instance(). */ /*! - \fn void ICore::coreOpened() + \fn void Core::ICore::coreOpened() Indicates that all plugins have been loaded and the main window is shown. */ /*! - \fn void ICore::saveSettingsRequested() + \fn void Core::ICore::saveSettingsRequested(Core::ICore::SaveSettingsReason reason) Signals that the user has requested that the global settings - should be saved to disk. + should be saved to disk for a \a reason. At the moment that happens when the application is closed, and on \uicontrol{Save All}. */ /*! - \fn void ICore::optionsDialogRequested() - Enables plugins to perform actions just before the \uicontrol Tools > \uicontrol Options - dialog is shown. -*/ - -/*! - \fn void ICore::coreAboutToClose() + \fn void Core::ICore::coreAboutToClose() Enables plugins to perform some pre-end-of-life actions. The application is guaranteed to shut down after this signal is emitted. @@ -289,13 +101,13 @@ */ /*! - \fn void ICore::contextAboutToChange(const QList<Core::IContext *> &context) + \fn void Core::ICore::contextAboutToChange(const QList<Core::IContext *> &context) Indicates that a new \a context will shortly become the current context (meaning that its widget got focus). */ /*! - \fn void ICore::contextChanged(const Core::Context &context) + \fn void Core::ICore::contextChanged(const Core::Context &context) Indicates that a new \a context just became the current context. This includes the context from the focus object as well as the additional context. */ @@ -341,6 +153,9 @@ QWidget *ICore::newItemDialog() return IWizardFactory::currentWizard(); } +/*! + \internal +*/ ICore::ICore(MainWindow *mainwindow) { m_instance = this; @@ -356,12 +171,29 @@ ICore::ICore(MainWindow *mainwindow) }); } +/*! + \internal +*/ ICore::~ICore() { m_instance = nullptr; m_mainwindow = nullptr; } +/*! + Opens a dialog where the user can choose from a set of \a factories that + create new files or projects. + + The \a title argument is shown as the dialog title. The path where the + files will be created (if the user does not change it) is set + in \a defaultLocation. Defaults to DocumentManager::projectsDirectory() + or DocumentManager::fileDialogLastVisitedDirectory(), depending on wizard + kind. + + Additional variables for the wizards are set in \a extraVariables. + + \sa Core::DocumentManager +*/ void ICore::showNewItemDialog(const QString &title, const QList<IWizardFactory *> &factories, const QString &defaultLocation, @@ -397,8 +229,18 @@ QString ICore::msgShowOptionsDialogToolTip() "msgShowOptionsDialogToolTip (non-mac version)"); } -// Display a warning with an additional button to open -// the settings dialog at a specified page if settingsId is nonempty. +/*! + Creates a message box with \a parent that contains a \uicontrol Settings + button for opening the settings page specified by \a settingsId. + + The dialog has \a title and displays the message \a text and detailed + information specified by \a details. + + Use this function to display configuration errors and to point users to the + setting they should fix. + + Returns \c true if the user accepted the settings dialog. +*/ bool ICore::showWarningWithOptions(const QString &title, const QString &text, const QString &details, Id settingsId, QWidget *parent) { @@ -417,6 +259,22 @@ bool ICore::showWarningWithOptions(const QString &title, const QString &text, return false; } +/*! + Returns the application's main settings object. + + You can use it to retrieve or set application-wide settings + (in contrast to session or project specific settings). + + If \a scope is \c QSettings::UserScope (the default), the + settings will be read from the user's settings, with + a fallback to global settings provided with \QC. + + If \a scope is \c QSettings::SystemScope, only the system settings + shipped with the current version of \QC will be read. This + functionality exists for internal purposes only. + + \see settingsDatabase() +*/ QSettings *ICore::settings(QSettings::Scope scope) { if (scope == QSettings::UserScope) @@ -425,11 +283,26 @@ QSettings *ICore::settings(QSettings::Scope scope) return PluginManager::globalSettings(); } +/*! + Returns the application's settings database. + + The settings database is meant as an alternative to the regular settings + object. It is more suitable for storing large amounts of data. The settings + are application wide. + + \see SettingsDatabase +*/ SettingsDatabase *ICore::settingsDatabase() { return m_mainwindow->settingsDatabase(); } +/*! + Returns the application's printer object. + + Always use this printer object for printing, so the different parts of the + application re-use its settings. +*/ QPrinter *ICore::printer() { return m_mainwindow->printer(); @@ -440,11 +313,27 @@ QString ICore::userInterfaceLanguage() return qApp->property("qtc_locale").toString(); } +/*! + Returns the absolute path that is used for resources like + project templates and the debugger macros. + + This abstraction is needed to avoid platform-specific code all over + the place, since on \macos, for example, the resources are part of the + application bundle. +*/ QString ICore::resourcePath() { return QDir::cleanPath(QCoreApplication::applicationDirPath() + '/' + RELATIVE_DATA_PATH); } +/*! + Returns the absolute path in the users directory that is used for + resources like project templates. + + Use this function for finding the place for resources that the user may + write to, for example, to allow for custom palettes or templates. +*/ + QString ICore::userResourcePath() { // Create qtcreator dir if it doesn't yet exist @@ -556,6 +445,11 @@ QString ICore::buildCompatibilityString() QString::number(QSysInfo::WordSize)); } +/*! + Returns the context object of the current main context. + + \sa updateAdditionalContexts(), addContextObject() +*/ IContext *ICore::currentContextObject() { return m_mainwindow->currentContextObject(); @@ -572,12 +466,19 @@ IContext *ICore::contextObject(QWidget *widget) return m_mainwindow->contextObject(widget); } +/*! + Returns the main window of the application. + For dialog parents use dialogParent(). +*/ QMainWindow *ICore::mainWindow() { return m_mainwindow; } +/*! + Returns a widget pointer suitable to use as parent for QDialogs. + */ QWidget *ICore::dialogParent() { QWidget *active = QApplication::activeModalWidget(); @@ -611,12 +512,21 @@ void ICore::raiseWindow(QWidget *widget) } } +/*! + Changes the currently active additional contexts. + + Removes the list of additional contexts specified by \a remove and adds the + list of additional contexts specified by \a add with \a priority. +*/ void ICore::updateAdditionalContexts(const Context &remove, const Context &add, ContextPriority priority) { m_mainwindow->updateAdditionalContexts(remove, add, priority); } +/*! + Adds \a context with \a priority. +*/ void ICore::addAdditionalContext(const Context &context, ContextPriority priority) { m_mainwindow->updateAdditionalContexts(Context(), context, priority); @@ -627,11 +537,23 @@ void ICore::removeAdditionalContext(const Context &context) m_mainwindow->updateAdditionalContexts(context, Context(), ContextPriority::Low); } +/*! + After registration, this context object automatically becomes the + current context object, \a context, whenever its widget gets focus. + + \sa removeContextObject(), updateAdditionalContexts(), + currentContextObject() +*/ void ICore::addContextObject(IContext *context) { m_mainwindow->addContextObject(context); } +/*! + Unregisters a \a context object from the list of know contexts. + + \sa addContextObject(), updateAdditionalContexts(), currentContextObject() +*/ void ICore::removeContextObject(IContext *context) { m_mainwindow->removeContextObject(context); @@ -642,21 +564,24 @@ void ICore::registerWindow(QWidget *window, const Context &context) new WindowSupport(window, context); // deletes itself when widget is destroyed } +/*! + Opens files using \a arguments and \a flags like it would be + done if they were given to \QC on the command line, or + they were opened via \uicontrol File > \uicontrol Open. +*/ + void ICore::openFiles(const QStringList &arguments, ICore::OpenFilesFlags flags) { m_mainwindow->openFiles(arguments, flags); } /*! - \fn ICore::addCloseCoreListener - - \brief The \c ICore::addCloseCoreListener function provides a hook for plugins - to veto on closing the application. + Provides a hook for plugins to veto on closing the application. - When the application window requests a close, all listeners are called. - If one if these calls returns \c false, the process is aborted and the - event is ignored. If all calls return \c true, \c ICore::coreAboutToClose() - is emitted and the event is accepted or performed.. + When the application window requests a close, all listeners are called. If + one of the \a listener calls returns \c false, the process is aborted and + the event is ignored. If all calls return \c true, coreAboutToClose() + is emitted and the event is accepted or performed. */ void ICore::addPreCloseListener(const std::function<bool ()> &listener) { diff --git a/src/plugins/coreplugin/id.cpp b/src/plugins/coreplugin/id.cpp index 8e3523b6b9..2db0ea2bb6 100644 --- a/src/plugins/coreplugin/id.cpp +++ b/src/plugins/coreplugin/id.cpp @@ -40,13 +40,14 @@ namespace Core { /*! \class Core::Id + \inmodule QtCreator \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 - \c QByteArray would provide. + in a more typesafe and faster manner than a plain QString or + QByteArray would provide. An id is associated with a plain 7-bit-clean ASCII name used for display and persistency. @@ -214,7 +215,7 @@ QVariant Id::toSetting() const } /*! - Reconstructs an id from a persistent value. + Reconstructs an id from the persistent value \a variant. \sa toSetting() */ @@ -277,8 +278,6 @@ Id Id::withSuffix(const char *suffix) const /*! \overload - - \sa stringSuffix() */ Id Id::withSuffix(const QString &suffix) const diff --git a/src/plugins/coreplugin/idocument.cpp b/src/plugins/coreplugin/idocument.cpp index aab9845f1a..7e3e0c4d9e 100644 --- a/src/plugins/coreplugin/idocument.cpp +++ b/src/plugins/coreplugin/idocument.cpp @@ -35,6 +35,8 @@ /*! \class Core::IDocument + \inmodule QtCreator + \brief The IDocument class describes a document that can be saved and reloaded. The most common use for implementing an IDocument subclass, is as a document for an IEditor @@ -46,7 +48,7 @@ Each IDocument subclass works only with the corresponding IEditor subclasses that it was designed to work with. - \mainclass + \ingroup mainclasses */ /*! @@ -156,9 +158,11 @@ QByteArray IDocument::contents() const } /*! - Used for example by EditorManager::openEditorWithContents() to set the contents - of this document. - Returns if setting the contents was successful. + Used for example by EditorManager::openEditorWithContents() to set + the \a contents of this document. + + Returns whether setting the contents was successful. + The base implementation does nothing and returns false. */ bool IDocument::setContents(const QByteArray &contents) @@ -333,14 +337,18 @@ void IDocument::setFilePath(const Utils::FilePath &filePath) } /*! - Returns the string to display for this document, e.g. in the open document combo box - and pane. + Returns the string to display for this document, in the open document combo + box and pane, for example. + The returned string has the following priority: - * Unique display name set by the document model - * Preferred display name set by the owner - * Base name of the document's file name - \sa setDisplayName() + \list 1 + \li Unique display name set by the document model + \li Preferred display name set by the owner + \li Base name of the document's file name + \endlist + + \sa setPreferredDisplayName() */ QString IDocument::displayName() const { diff --git a/src/plugins/coreplugin/inavigationwidgetfactory.cpp b/src/plugins/coreplugin/inavigationwidgetfactory.cpp index 7fd39cccb7..f1aaa5e1c4 100644 --- a/src/plugins/coreplugin/inavigationwidgetfactory.cpp +++ b/src/plugins/coreplugin/inavigationwidgetfactory.cpp @@ -32,8 +32,8 @@ /*! \class Core::INavigationWidgetFactory - \mainclass - \inmodule Qt Creator + \ingroup mainclasses + \inmodule QtCreator \brief The INavigationWidgetFactory class provides new instances of navigation widgets. A navigation widget factory is necessary because there can be more than one navigation widget of diff --git a/src/plugins/coreplugin/ioutputpane.cpp b/src/plugins/coreplugin/ioutputpane.cpp index 5efaeeb7be..c43eff0c85 100644 --- a/src/plugins/coreplugin/ioutputpane.cpp +++ b/src/plugins/coreplugin/ioutputpane.cpp @@ -29,10 +29,10 @@ /*! \class Core::IOutputPane - \brief The IOutputPane class is an interface for providing \gui Output panes. + \brief The IOutputPane class is an interface for providing \uicontrol Output panes. - \mainclass - \inmodule Qt Creator + \ingroup mainclasses + \inmodule QtCreator */ /*! @@ -131,7 +131,7 @@ /*! \fn bool IOutputPane::canNext() const - Determines whether the \gui Next button in the output pane is enabled. + Determines whether the \uicontrol Next button in the output pane is enabled. Is overwritten when \c canNavigate() returns \c false. \sa IOutputPane::canNavigate() @@ -142,7 +142,7 @@ /*! \fn bool IOutputPane::canPrevious() const - Determines whether the \gui Previous button in the output pane is enabled. + Determines whether the \uicontrol Previous button in the output pane is enabled. Is overwritten when \c canNavigate() returns \c false. \sa IOutputPane::canNavigate() @@ -153,7 +153,7 @@ /*! \fn void IOutputPane::goToNext() - Is called on selecting the \gui Next button. + Is called on selecting the \uicontrol Next button. \sa IOutputPane::canNext() */ @@ -161,7 +161,7 @@ /*! \fn void IOutputPane::goToPrev() - Is called on selecting the \gui Previous button. + Is called on selecting the \uicontrol Previous button. \sa IOutputPane::canPrevious() */ diff --git a/src/plugins/coreplugin/mainwindow.cpp b/src/plugins/coreplugin/mainwindow.cpp index 4af57a6fd9..ea2e8db147 100644 --- a/src/plugins/coreplugin/mainwindow.cpp +++ b/src/plugins/coreplugin/mainwindow.cpp @@ -829,7 +829,9 @@ static IDocumentFactory *findDocumentFactory(const QList<IDocumentFactory*> &fil }); } -/*! Either opens \a fileNames with editors or loads a project. +/*! + * \internal + * Either opens \a fileNames with editors or loads a project. * * \a flags can be used to stop on first failure, indicate that a file name * might include line numbers and/or switch mode to edit mode. @@ -837,7 +839,7 @@ static IDocumentFactory *findDocumentFactory(const QList<IDocumentFactory*> &fil * \a workingDirectory is used when files are opened by a remote client, since * the file names are relative to the client working directory. * - * \returns the first opened document. Required to support the -block flag + * Returns the first opened document. Required to support the \c -block flag * for client mode. * * \sa IPlugin::remoteArguments() diff --git a/src/plugins/coreplugin/minisplitter.cpp b/src/plugins/coreplugin/minisplitter.cpp index 99de649d18..af7ee03c03 100644 --- a/src/plugins/coreplugin/minisplitter.cpp +++ b/src/plugins/coreplugin/minisplitter.cpp @@ -78,6 +78,22 @@ void MiniSplitterHandle::paintEvent(QPaintEvent *event) painter.fillRect(event->rect(), color); } +/*! + \class Core::MiniSplitter + \inmodule QtCreator + + \brief The MiniSplitter class is a simple helper-class to obtain + \macos style 1-pixel wide splitters. +*/ + +/*! + \enum Core::MiniSplitter::SplitterStyle + This enum value holds the splitter style. + + \value Dark Dark style. + \value Light Light style. +*/ + QSplitterHandle *MiniSplitter::createHandle() { return new MiniSplitterHandle(orientation(), this, m_style == Light); @@ -102,11 +118,11 @@ MiniSplitter::MiniSplitter(Qt::Orientation orientation, QWidget *parent, Splitte } /*! - \class NonResizingSplitter - \inmodule Qt Creator + \class Core::NonResizingSplitter + \inmodule QtCreator - The NonResizingSplitter class is a MiniSplitter that keeps its first widget's size fixed - when it is resized. + \brief The NonResizingSplitter class is a MiniSplitter that keeps its + first widget's size fixed when it is resized. */ /*! diff --git a/src/plugins/coreplugin/modemanager.cpp b/src/plugins/coreplugin/modemanager.cpp index 536c6e4714..cbacdaa371 100644 --- a/src/plugins/coreplugin/modemanager.cpp +++ b/src/plugins/coreplugin/modemanager.cpp @@ -50,11 +50,15 @@ namespace Core { /*! \class Core::ModeManager + \inmodule QtCreator + + \brief The ModeManager class implements a mode manager. The mode manager handles everything related to the instances of IMode - that were added to the plugin manager's object pool as well as their - buttons and the tool bar with the round buttons in the lower left - corner of Qt Creator. + that were added to the plugin manager's object pool. + + In addition, it handles the mode buttons and the tool bar buttons in the + lower left corner of \QC. */ struct ModeManagerPrivate diff --git a/src/plugins/coreplugin/settingsdatabase.cpp b/src/plugins/coreplugin/settingsdatabase.cpp index f3f52317d8..514b40ca5b 100644 --- a/src/plugins/coreplugin/settingsdatabase.cpp +++ b/src/plugins/coreplugin/settingsdatabase.cpp @@ -38,6 +38,7 @@ /*! \class Core::SettingsDatabase + \inmodule QtCreator \brief The SettingsDatabase class offers an alternative to the application-wide QSettings that is more suitable for storing large amounts of data. diff --git a/src/plugins/coreplugin/statusbarmanager.cpp b/src/plugins/coreplugin/statusbarmanager.cpp index a5d4848981..bd9d86d5bb 100644 --- a/src/plugins/coreplugin/statusbarmanager.cpp +++ b/src/plugins/coreplugin/statusbarmanager.cpp @@ -47,7 +47,7 @@ static QPointer<QSplitter> m_splitter; static QList<QPointer<QWidget>> m_statusBarWidgets; static QList<QPointer<IContext>> m_contexts; -/*! +/* Context that always returns the context of the active's mode widget (if available). */ class StatusBarContext : public IContext diff --git a/src/plugins/coreplugin/textdocument.cpp b/src/plugins/coreplugin/textdocument.cpp index ca1eacf57b..b82605e41d 100644 --- a/src/plugins/coreplugin/textdocument.cpp +++ b/src/plugins/coreplugin/textdocument.cpp @@ -30,13 +30,15 @@ #include <QTextCodec> /*! - \class Core::TextDocument - \brief The TextDocument class is a very general base class for documents that work with text. + \class Core::BaseTextDocument + \inmodule QtCreator + \brief The BaseTextDocument class is a very general base class for + documents that work with text. This class contains helper methods for saving and reading text files with encoding and line ending settings. - \sa Utils::TextFileUtils + \sa Utils::TextFileFormat */ enum { debug = 0 }; @@ -78,7 +80,13 @@ QByteArray BaseTextDocument::decodingErrorSample() const } /*! - Writes out text using the format obtained from the last read. + Writes out the contents (\a data) of the text file \a fileName. + Uses the format obtained from the last read() of the file. + + If an error occurs while writing the file, \a errorMessage is set to the + error details. + + Returns whether the operation was successful. */ bool BaseTextDocument::write(const QString &fileName, const QString &data, QString *errorMessage) const @@ -87,7 +95,13 @@ bool BaseTextDocument::write(const QString &fileName, const QString &data, QStri } /*! - Writes out text using a custom \a format. + Writes out the contents (\a data) of the text file \a fileName. + Uses the custom format \a format. + + If an error occurs while writing the file, \a errorMessage is set to the + error details. + + Returns whether the operation was successful. */ bool BaseTextDocument::write(const QString &fileName, const Utils::TextFileFormat &format, const QString &data, QString *errorMessage) const @@ -108,7 +122,13 @@ void BaseTextDocument::setLineTerminationMode(Utils::TextFileFormat::LineTermina } /*! - Autodetects format and reads in the text file specified by \a fileName. + Autodetects file format and reads the text file specified by \a fileName + into a list of strings specified by \a plainTextList. + + If an error occurs while writing the file, \a errorMessage is set to the + error details. + + Returns whether the operation was successful. */ BaseTextDocument::ReadResult BaseTextDocument::read(const QString &fileName, QStringList *plainTextList, QString *errorString) @@ -120,7 +140,13 @@ BaseTextDocument::ReadResult BaseTextDocument::read(const QString &fileName, QSt } /*! - Autodetects format and reads in the text file specified by \a fileName. + Autodetects file format and reads the text file specified by \a fileName + into \a plainText. + + If an error occurs while writing the file, \a errorMessage is set to the + error details. + + Returns whether the operation was successful. */ BaseTextDocument::ReadResult BaseTextDocument::read(const QString &fileName, QString *plainText, QString *errorString) @@ -161,7 +187,7 @@ Utils::TextFileFormat::LineTerminationMode BaseTextDocument::lineTerminationMode } /*! - Returns the format obtained from the last call to \c read(). + Returns the format obtained from the last call to read(). */ Utils::TextFileFormat BaseTextDocument::format() const |