diff options
133 files changed, 1384 insertions, 1324 deletions
diff --git a/src/libs/extensionsystem/pluginmanager.cpp b/src/libs/extensionsystem/pluginmanager.cpp index a8fd4f8d59..628df09b2d 100644 --- a/src/libs/extensionsystem/pluginmanager.cpp +++ b/src/libs/extensionsystem/pluginmanager.cpp @@ -88,19 +88,20 @@ enum { debugLeaks = 0 }; \endlist \section1 Plugins - Plugins consist of an xml descriptor file, and of a library that contains a Qt plugin + Plugins consist of an XML descriptor file, and of a library that contains a Qt plugin (declared via Q_EXPORT_PLUGIN) that must derive from the IPlugin class. The plugin manager is used to set a list of file system directories to search for plugins, retrieve information about the state of these plugins, and to load them. - Usually the application creates a PluginManager instance and initiates the loading. + Usually, the application creates a PluginManager instance and initiates the + loading. \code // 'plugins' and subdirs will be searched for plugins ExtensionSystem::PluginManager::setPluginPaths(QStringList() << "plugins"); ExtensionSystem::PluginManager::loadPlugins(); // try to load all the plugins \endcode - Additionally it is possible to directly access to the plugin specifications - (the information in the descriptor file), and the plugin instances (via PluginSpec), + Additionally, it is possible to directly access the plugin specifications + (the information in the descriptor file), the plugin instances (via PluginSpec), and their state. \section1 Object Pool @@ -199,17 +200,17 @@ enum { debugLeaks = 0 }; /*! \fn void PluginManager::objectAdded(QObject *obj) - Signal that \a obj has been added to the object pool. + Signals that \a obj has been added to the object pool. */ /*! \fn void PluginManager::aboutToRemoveObject(QObject *obj) - Signal that \a obj will be removed from the object pool. + Signals that \a obj will be removed from the object pool. */ /*! \fn void PluginManager::pluginsChanged() - Signal that the list of available plugins has changed. + Signals that the list of available plugins has changed. \sa plugins() */ @@ -217,9 +218,10 @@ enum { debugLeaks = 0 }; /*! \fn T *PluginManager::getObject() - Retrieve the object of a given type from the object pool. - This method is aware of Aggregation::Aggregate, i.e. it uses - the Aggregation::query methods instead of qobject_cast to + Retrieves the object of a given type from the object pool. + + This method is aware of Aggregation::Aggregate. That is, it uses + the \c Aggregation::query methods instead of \c qobject_cast to determine the type of an object. If there are more than one object of the given type in the object pool, this method will choose an arbitrary one of them. @@ -229,9 +231,11 @@ enum { debugLeaks = 0 }; /*! \fn QList<T *> PluginManager::getObjects() - Retrieve all objects of a given type from the object pool. - This method is aware of Aggregation::Aggregate, i.e. it uses - the Aggregation::query methods instead of qobject_cast to + + Retrieves all objects of a given type from the object pool. + + This method is aware of Aggregation::Aggregate. That is, it uses + the \c Aggregation::query methods instead of \c qobject_cast to determine the type of an object. \sa addObject() @@ -249,7 +253,7 @@ static bool lessThanByPluginName(const PluginSpec *one, const PluginSpec *two) } /*! - Get the unique plugin manager instance. + Gets the unique plugin manager instance. */ PluginManager *PluginManager::instance() { @@ -257,7 +261,7 @@ PluginManager *PluginManager::instance() } /*! - Create a plugin manager. Should be done only once per application. + Creates a plugin manager. Should be done only once per application. */ PluginManager::PluginManager() { @@ -275,7 +279,9 @@ PluginManager::~PluginManager() } /*! - Add the given object \a obj to the object pool, so it can be retrieved again from the pool by type. + Adds the object \a obj to the object pool, so it can be retrieved + again from the pool by type. + The plugin manager does not do any memory management - added objects must be removed from the pool and deleted manually by whoever is responsible for the object. @@ -300,8 +306,10 @@ void PluginManager::removeObject(QObject *obj) } /*! - Retrieve the list of all objects in the pool, unfiltered. - Usually clients do not need to call this. + Retrieves the list of all objects in the pool, unfiltered. + + Usually, clients do not need to call this function. + \sa PluginManager::getObject() \sa PluginManager::getObjects() */ @@ -396,7 +404,8 @@ void PluginManager::setFileExtension(const QString &extension) } /*! - Define the user specific settings to use for information about enabled/disabled plugins. + Defines the user specific settings to use for information about enabled and + disabled plugins. Needs to be set before the plugin search path is set with setPluginPaths(). */ void PluginManager::setSettings(QSettings *settings) @@ -405,7 +414,8 @@ void PluginManager::setSettings(QSettings *settings) } /*! - Define the global (user-independent) settings to use for information about default disabled plugins. + Defines the global (user-independent) settings to use for information about + default disabled plugins. Needs to be set before the plugin search path is set with setPluginPaths(). */ void PluginManager::setGlobalSettings(QSettings *settings) @@ -414,7 +424,8 @@ void PluginManager::setGlobalSettings(QSettings *settings) } /*! - Returns the user specific settings used for information about enabled/disabled plugins. + Returns the user specific settings used for information about enabled and + disabled plugins. */ QSettings *PluginManager::settings() { @@ -435,7 +446,7 @@ void PluginManager::writeSettings() } /*! - The arguments left over after parsing (Neither startup nor plugin + The arguments left over after parsing (that were neither startup nor plugin arguments). Typically, this will be the list of files to open. */ QStringList PluginManager::arguments() @@ -465,7 +476,7 @@ QHash<QString, PluginCollection *> PluginManager::pluginCollections() static const char argumentKeywordC[] = ":arguments"; /*! - Serialize plugin options and arguments for sending in a single string + Serializes plugin options and arguments for sending in a single string via QtSingleApplication: ":myplugin|-option1|-option2|:arguments|argument1|argument2", as a list of lists started by a keyword with a colon. Arguments are last. @@ -599,7 +610,7 @@ static inline void formatOption(QTextStream &str, } /*! - Format the startup options of the plugin manager for command line help. + Formats the startup options of the plugin manager for command line help. */ void PluginManager::formatOptions(QTextStream &str, int optionIndentation, int descriptionIndentation) @@ -625,7 +636,7 @@ void PluginManager::formatOptions(QTextStream &str, int optionIndentation, int d } /*! - Format the plugin options of the plugin specs for command line help. + Formats the plugin options of the plugin specs for command line help. */ void PluginManager::formatPluginOptions(QTextStream &str, int optionIndentation, int descriptionIndentation) @@ -645,7 +656,7 @@ void PluginManager::formatPluginOptions(QTextStream &str, int optionIndentation, } /*! - Format the version of the plugin specs for command line help. + Formats the version of the plugin specs for command line help. */ void PluginManager::formatPluginVersions(QTextStream &str) { @@ -762,7 +773,8 @@ QString PluginManager::testDataDirectory() } /*! - Create a profiling entry showing the elapsed time if profiling is activated. + Creates a profiling entry showing the elapsed time if profiling is + activated. */ void PluginManager::profilingReport(const char *what, const PluginSpec *spec) @@ -1403,7 +1415,7 @@ QString PluginManager::platformName() } /*! - \brief Retrieves one object with a given name from the object pool. + Retrieves one object with \a name from the object pool. \sa addObject() */ @@ -1419,7 +1431,8 @@ QObject *PluginManager::getObjectByName(const QString &name) } /*! - Retrieves one object inheriting a class with a given name from the object pool. + Retrieves one object inheriting a class with \a className from the object + pool. \sa addObject() */ diff --git a/src/libs/extensionsystem/pluginspec.cpp b/src/libs/extensionsystem/pluginspec.cpp index 7bdefc908c..1f6c8f8acd 100644 --- a/src/libs/extensionsystem/pluginspec.cpp +++ b/src/libs/extensionsystem/pluginspec.cpp @@ -66,8 +66,9 @@ \brief The PluginDependency class contains the name and required compatible version number of a plugin's dependency. - This reflects the data of a dependency tag in the plugin's xml description file. - The name and version are used to resolve the dependency, i.e. a plugin with the given name and + This reflects the data of a dependency tag in the plugin's XML description + file. The name and version are used to resolve the dependency. That is, + a plugin with the given name and plugin \c {compatibility version <= dependency version <= plugin version} is searched for. See also ExtensionSystem::IPlugin for more information about plugin dependencies and @@ -115,14 +116,15 @@ /*! \enum ExtensionSystem::PluginSpec::State + The State enum indicates the states the plugin goes through while + it is being loaded. - The plugin goes through several steps while being loaded. The state gives a hint on what went wrong in case of an error. \value Invalid - Starting point: Even the xml description file was not read. + Starting point: Even the XML description file was not read. \value Read - The xml description file has been successfully read, and its + The XML description file has been successfully read, and its information is available via the PluginSpec. \value Resolved The dependencies given in the description file have been @@ -236,7 +238,8 @@ QString PluginSpec::description() const } /*! - The plugin url where you can find more information about the plugin. This is valid after the PluginSpec::Read state is reached. + The plugin URL where you can find more information about the plugin. + This is valid after the PluginSpec::Read state is reached. */ QString PluginSpec::url() const { @@ -263,7 +266,7 @@ QRegExp PluginSpec::platformSpecification() const } /*! - Returns if the plugin has its experimental flag set. + Returns whether the plugin has its experimental flag set. */ bool PluginSpec::isExperimental() const { @@ -271,7 +274,7 @@ bool PluginSpec::isExperimental() const } /*! - Returns if the plugin is disabled by default. + Returns whether the plugin is disabled by default. This might be because the plugin is experimental, or because the plugin manager's settings define it as disabled by default. */ @@ -281,10 +284,12 @@ bool PluginSpec::isDisabledByDefault() const } /*! - Returns if the plugin should be loaded at startup. True by default + Returns whether the plugin should be loaded at startup. True by default. + The user can change it from the Plugin settings. - Note: That this function returns true even if a plugin is disabled because - of a not loaded dependencies, or a error in loading. + + \note This function returns true even if a plugin is disabled because its + dependencies were not loaded, or an error occurred during loading it. */ bool PluginSpec::isEnabledInSettings() const { @@ -292,7 +297,7 @@ bool PluginSpec::isEnabledInSettings() const } /*! - Returns if the plugin is loaded at startup. + Returns whether the plugin is loaded at startup. \see PluginSpec::isEnabled */ bool PluginSpec::isEffectivelyEnabled() const @@ -314,7 +319,7 @@ bool PluginSpec::isDisabledIndirectly() const } /*! - Returns if the plugin is enabled via the -load option on the command line. + Returns whether the plugin is enabled via the -load option on the command line. */ bool PluginSpec::isForceEnabled() const { @@ -322,7 +327,7 @@ bool PluginSpec::isForceEnabled() const } /*! - Returns if the plugin is disabled via the -noload option on the command line. + Returns whether the plugin is disabled via the -noload option on the command line. */ bool PluginSpec::isForceDisabled() const { @@ -347,7 +352,7 @@ PluginSpec::PluginArgumentDescriptions PluginSpec::argumentDescriptions() const } /*! - The absolute path to the directory containing the plugin xml description file + The absolute path to the directory containing the plugin XML description file this PluginSpec corresponds to. */ QString PluginSpec::location() const @@ -356,7 +361,7 @@ QString PluginSpec::location() const } /*! - The absolute path to the plugin xml description file (including the file name) + The absolute path to the plugin XML description file (including the file name) this PluginSpec corresponds to. */ QString PluginSpec::filePath() const @@ -365,7 +370,7 @@ QString PluginSpec::filePath() const } /*! - Command line arguments specific to that plugin. Set at startup + Command line arguments specific to the plugin. Set at startup. */ QStringList PluginSpec::arguments() const @@ -374,7 +379,7 @@ QStringList PluginSpec::arguments() const } /*! - Set the command line arguments specific to that plugin to \a arguments. + Sets the command line arguments specific to the plugin to \a arguments. */ void PluginSpec::setArguments(const QStringList &arguments) @@ -383,7 +388,7 @@ void PluginSpec::setArguments(const QStringList &arguments) } /*! - Adds \a argument to the command line arguments specific to that plugin. + Adds \a argument to the command line arguments specific to the plugin. */ void PluginSpec::addArgument(const QString &argument) @@ -418,7 +423,7 @@ QString PluginSpec::errorString() const } /*! - Returns if this plugin can be used to fill in a dependency of the given + Returns whether this plugin can be used to fill in a dependency of the given \a pluginName and \a version. \sa PluginSpec::dependencies() diff --git a/src/libs/extensionsystem/pluginview.cpp b/src/libs/extensionsystem/pluginview.cpp index 61fcc577dc..b8401fc568 100644 --- a/src/libs/extensionsystem/pluginview.cpp +++ b/src/libs/extensionsystem/pluginview.cpp @@ -45,9 +45,9 @@ \brief The PluginView class implements a widget that shows a list of all plugins and their state. - This can be embedded e.g. in a dialog in the application that + This class can be embedded for example in a dialog in the application that uses the plugin manager. - The class also provides notifications for interactions with the list. + The class also provides notifications for interaction with the list. \sa ExtensionSystem::PluginDetailsView \sa ExtensionSystem::PluginErrorView @@ -62,7 +62,7 @@ /*! \fn void PluginView::pluginActivated(ExtensionSystem::PluginSpec *spec) The plugin list entry corresponding to \a spec has been activated, - e.g. by a double-click. + for example by a double-click. */ using namespace ExtensionSystem; diff --git a/src/libs/qmldebug/qpacketprotocol.cpp b/src/libs/qmldebug/qpacketprotocol.cpp index 4bc56c2173..6205ceec71 100644 --- a/src/libs/qmldebug/qpacketprotocol.cpp +++ b/src/libs/qmldebug/qpacketprotocol.cpp @@ -207,7 +207,7 @@ public: }; /*! - Construct a QPacketProtocol instance that works on \a dev with the + Constructs a QPacketProtocol instance that works on \a dev with the specified \a parent. */ QPacketProtocol::QPacketProtocol(QIODevice *dev, QObject *parent) @@ -265,7 +265,7 @@ QPacketAutoSend QPacketProtocol::send() } /*! - Transmit the \a packet. + Transmits the packet \a p. */ void QPacketProtocol::send(const QPacket & p) { @@ -292,7 +292,7 @@ qint64 QPacketProtocol::packetsAvailable() const } /*! - Discard any unread packets. + Discards any unread packets. */ void QPacketProtocol::clear() { @@ -300,7 +300,7 @@ void QPacketProtocol::clear() } /*! - Return the next unread packet, or an invalid QPacket instance if no packets + Returns the next unread packet, or an invalid QPacket instance if no packets are available. This method does NOT block. */ QPacket QPacketProtocol::read() @@ -314,8 +314,8 @@ QPacket QPacketProtocol::read() } -/* - Returns the difference between msecs and elapsed. If msecs is -1, +/*! + Returns the difference between \a msecs and \a elapsed. If msecs is -1, however, -1 is returned. */ static int qt_timeout_value(int msecs, int elapsed) @@ -328,13 +328,13 @@ static int qt_timeout_value(int msecs, int elapsed) } /*! - This function locks until a new packet is available for reading and the + Locks until a new packet is available for reading and the \l{QIODevice::}{readyRead()} signal has been emitted. The function will timeout after \a msecs milliseconds; the default timeout is 30000 milliseconds. - The function returns true if the readyRead() signal is emitted and - there is new data available for reading; otherwise it returns false + Returns true if the readyRead() signal is emitted and + there is new data available for reading; otherwise returns false (if an error occurred or the operation timed out). */ @@ -357,7 +357,7 @@ bool QPacketProtocol::waitForReadyRead(int msecs) } /*! - Return the QIODevice passed to the QPacketProtocol constructor. + Returns the QIODevice passed to the QPacketProtocol constructor. */ QIODevice *QPacketProtocol::device() { @@ -382,7 +382,7 @@ QIODevice *QPacketProtocol::device() /*! \fn void QPacketProtocol::packetWritten() - Emitted each time a packet is completing written to the device. This signal + Emitted each time a packet is completely written to the device. This signal may be used for communications flow control. */ @@ -521,7 +521,6 @@ void QPacket::clear() \class QPacketAutoSend \internal - \internal */ QPacketAutoSend::QPacketAutoSend(QPacketProtocol *_p) : QPacket(), p(_p) diff --git a/src/libs/qmljs/parser/qmlerror.cpp b/src/libs/qmljs/parser/qmlerror.cpp index b097eea812..09e90df4ef 100644 --- a/src/libs/qmljs/parser/qmlerror.cpp +++ b/src/libs/qmljs/parser/qmlerror.cpp @@ -59,7 +59,7 @@ QT_BEGIN_NAMESPACE ^ \endcode - Note that the QtQuick 1 version is named QDeclarativeError + \note The QtQuick 1 version is named QDeclarativeError. \sa QQuickView::errors(), QmlComponent::errors() */ @@ -137,7 +137,7 @@ bool QmlError::isValid() const } /*! - Returns the url for the file that caused this error. + Returns the URL for the file that caused this error. */ QUrl QmlError::url() const { diff --git a/src/libs/qmljs/persistenttrie.cpp b/src/libs/qmljs/persistenttrie.cpp index e12fa90875..74c9593c7d 100644 --- a/src/libs/qmljs/persistenttrie.cpp +++ b/src/libs/qmljs/persistenttrie.cpp @@ -34,27 +34,27 @@ persistent (not on disk but in memory). This means that several versions can coexist, as adding an element - is non destructive, and as much as possible is shared. + is non-destructive, and as much as possible is shared. - The trie is only *partially* ordered, it preserves the order - of what was inserted as much as possible. + The trie is only \e partially ordered. It preserves the order + of the inserted elements as much as possible. This makes some operations a bit slower, but is considered a feature. This means the order in which you insert the elements matters. An important use case for this is completions, and several strategies are available. - Results order can be improved using the matching strength + Results order can be improved by using the matching strength. All const operations are threadsafe, and copy is cheap (only a QSharedPointer copy). - Assigning a shared pointer is *not* threadsafe, so updating the - head is *not* thread safe, and should be done only on a local + Assigning a shared pointer is not threadsafe, so updating the + head is not threadsafe, and should be done only on a local instance (shared pointer used only from a single thread), or protected with locks. - This is a two level implementation, based on a fully functional + This is a two-level implementation, based on a fully functional implementation (PersistentTrie::Trie), which could be private but was left public because deemed useful. @@ -570,10 +570,10 @@ QStringList Trie::stringList() const } /*! - \brief inserts into the current trie. + Inserts into the current trie. - Non thread safe, only use this on an instance that is used only - in a single theread, or that is protected by locks. + Non threadsafe. Only use this function on an instance that is used only + in a single thread, or that is protected by locks. */ void Trie::insert(const QString &value) { @@ -581,10 +581,10 @@ void Trie::insert(const QString &value) } /*! - \brief intesects into the current trie. + Intersects into the current trie. - Non thread safe, only use this on an instance that is used only - in a single theread, or that is protected by locks. + Non threadsafe. Only use this function on an instance that is used only + in a single thread, or that is protected by locks. */ void Trie::intersect(const Trie &v) { @@ -592,10 +592,10 @@ void Trie::intersect(const Trie &v) } /*! - \brief merges the given trie into the current one. + Merges the given trie into the current one. - Non thread safe, only use this on an instance that is used only - in a single theread, or that is protected by locks. + Non threadsafe. Only use this function on an instance that is used only + in a single thread, or that is protected by locks. */ void Trie::merge(const Trie &v) { @@ -643,11 +643,12 @@ Trie Trie::replaceF(const QHash<QString, QString> &replacements) const } /*! - Returns a number defining how well the serachStr matches str. - Quite simplistic, looks only at the first match, and prefers contiguos + Returns a number defining how well \a searchStr matches \a str. + + Quite simplistic, looks only at the first match, and prefers contiguous matches, or matches to capitalized or separated words. - Match to the last char is also preferred. + Match to the last character is also preferred. */ int matchStrength(const QString &searchStr, const QString &str) { @@ -691,7 +692,7 @@ public: } /*! - returns a number defining the matching strength of res to the given searchStr + Returns a number defining the matching strength of \a res to \a searchStr. */ QStringList matchStrengthSort(const QString &searchStr, QStringList &res) { diff --git a/src/libs/qmljs/qmljsdocument.cpp b/src/libs/qmljs/qmljsdocument.cpp index b75a74aae9..942882ef1a 100644 --- a/src/libs/qmljs/qmljsdocument.cpp +++ b/src/libs/qmljs/qmljsdocument.cpp @@ -61,7 +61,7 @@ using namespace QmlJS::AST; \sa Snapshot A LibraryInfo is created when the ModelManagerInterface finds - a Qml library and parses the qmldir file. The instance holds information about + a QML library and parses the qmldir file. The instance holds information about which Components the library provides and which plugins to load. The ModelManager will try to extract detailed information about the types diff --git a/src/libs/qmljs/qmljsinterpreter.cpp b/src/libs/qmljs/qmljsinterpreter.cpp index c74d5c4086..ddecffd2f1 100644 --- a/src/libs/qmljs/qmljsinterpreter.cpp +++ b/src/libs/qmljs/qmljsinterpreter.cpp @@ -369,9 +369,10 @@ const CppComponentValue *CppComponentValue::prototype() const } /*! - \returns a list started by this object and followed by all its prototypes + Returns a list started by this object and followed by all its prototypes. - Prefer to use this over calling prototype() in a loop, as it avoids cycles. + Use this function rather than calling prototype() in a loop, as it avoids + cycles. */ QList<const CppComponentValue *> CppComponentValue::prototypes() const { diff --git a/src/libs/qtcomponents/styleitem/qrangemodel.cpp b/src/libs/qtcomponents/styleitem/qrangemodel.cpp index 8217ff3e44..03f5758fb1 100644 --- a/src/libs/qtcomponents/styleitem/qrangemodel.cpp +++ b/src/libs/qtcomponents/styleitem/qrangemodel.cpp @@ -168,7 +168,7 @@ void QRangeModelPrivate::emitValueAndPositionIfChanged(const qreal oldValue, con } /*! - Constructs a QRangeModel with \a parent + Constructs a QRangeModel with \a parent. */ QRangeModel::QRangeModel(QObject *parent) @@ -180,7 +180,7 @@ QRangeModel::QRangeModel(QObject *parent) /*! \internal - Constructs a QRangeModel with private class pointer \a dd and \a parent + Constructs a QRangeModel with private class pointer \a dd and \a parent. */ QRangeModel::QRangeModel(QRangeModelPrivate &dd, QObject *parent) @@ -203,7 +203,7 @@ QRangeModel::~QRangeModel() /*! Sets the range of valid positions, that \l position can assume externally, with \a min and \a max. - Such range is represented by \l positionAtMinimum and \l positionAtMaximum + Such range is represented by \l positionAtMinimum and \l positionAtMaximum. */ void QRangeModel::setPositionRange(qreal min, qreal max) @@ -238,7 +238,7 @@ void QRangeModel::setPositionRange(qreal min, qreal max) /*! Sets the range of valid values, that \l value can assume externally, with \a min and \a max. The range has the following constraint: \a min must be less or equal \a max - Such range is represented by \l minimumValue and \l maximumValue + Such range is represented by \l minimumValue and \l maximumValue. */ void QRangeModel::setRange(qreal min, qreal max) @@ -476,7 +476,7 @@ void QRangeModel::setValue(qreal newValue) /*! \property QRangeModel::inverted - \brief the model is inverted or not + \brief whether the model is inverted or not The model can be represented with an inverted behavior, e.g. when \l value assumes the maximum value (represented by \l maximumValue) the \l position will be at its diff --git a/src/libs/qtcreatorcdbext/qtcreatorcdbextension.cpp b/src/libs/qtcreatorcdbext/qtcreatorcdbextension.cpp index 42203d58d6..f3cc7bbedf 100644 --- a/src/libs/qtcreatorcdbext/qtcreatorcdbextension.cpp +++ b/src/libs/qtcreatorcdbext/qtcreatorcdbextension.cpp @@ -42,12 +42,10 @@ /*! \group qtcreatorcdbext - \title Qt Creator CDB extension + \title Qt Creator CDB Extensions - \brief QtCreatorCDB ext is an extension loaded into CDB.exe (see cdbengine.cpp). - - - It provides + Qt Creator CDB extensions are loaded into CDB.exe (see cdbengine.cpp). + They provide the following features: \list \li Notification about the state of the debugging session: diff --git a/src/libs/qtcreatorcdbext/symbolgroup.cpp b/src/libs/qtcreatorcdbext/symbolgroup.cpp index 5fc8113fdc..5edd3575f9 100644 --- a/src/libs/qtcreatorcdbext/symbolgroup.cpp +++ b/src/libs/qtcreatorcdbext/symbolgroup.cpp @@ -808,7 +808,7 @@ WatchesSymbolGroup::InameExpressionMap } /*! - \brief Collapse all expanded pointer items. + Collapses all expanded pointer items. If we have an item '*(Foo*)(address_of_Foo_D_Ptr)' and the D-Ptr changes due to detaching, the expanded items (whose address diff --git a/src/libs/qtcreatorcdbext/symbolgroupvalue.cpp b/src/libs/qtcreatorcdbext/symbolgroupvalue.cpp index 2a1200a953..47168746fd 100644 --- a/src/libs/qtcreatorcdbext/symbolgroupvalue.cpp +++ b/src/libs/qtcreatorcdbext/symbolgroupvalue.cpp @@ -66,7 +66,8 @@ typedef std::vector<int>::size_type VectorIndexType; if (SymbolGroupValue sizeV = container["d"]["size"]) int size = sizeV.intValue() \endcode - etc. \ingroup qtcreatorcdbext */ + \ingroup qtcreatorcdbext + */ unsigned SymbolGroupValue::verbose = 0; @@ -691,7 +692,8 @@ static inline std::string resolveQtSymbol(const char *symbolC, Namespace, modules, and basic class names containing the module for fast lookup. - \ingroup qtcreatorcdbext */ + \ingroup qtcreatorcdbext +*/ const QtInfo &QtInfo::get(const SymbolGroupValueContext &ctx) { diff --git a/src/libs/utils/bracematcher.cpp b/src/libs/utils/bracematcher.cpp index 770c045e86..036b5f7f4e 100644 --- a/src/libs/utils/bracematcher.cpp +++ b/src/libs/utils/bracematcher.cpp @@ -38,13 +38,13 @@ and quotes. This is a helper class for autocompleter implementations. To use it, - define "brace", "quote", and "delimiter" characters for given language. + define \e brace, \e quote, and \e delimiter characters for a given language. */ namespace Utils { /*! - * Adds a pair of characters, corresponding to opening and closing braces. + * Adds a pair of characters, corresponding to \a opening and \a closing braces. */ void BraceMatcher::addBraceCharPair(const QChar opening, const QChar closing) { @@ -52,7 +52,7 @@ void BraceMatcher::addBraceCharPair(const QChar opening, const QChar closing) } /*! - * Adds quote character + * Adds a \a quote character. */ void BraceMatcher::addQuoteChar(const QChar quote) { @@ -60,8 +60,8 @@ void BraceMatcher::addQuoteChar(const QChar quote) } /*! - * Adds separator character that should be skipped when overtyping it, e.g. - * it could be ';' or ',' in C-like languages. + * Adds a separator character \a sep that should be skipped when overtyping it. + * For example, it could be ';' or ',' in C-like languages. */ void BraceMatcher::addDelimiterChar(const QChar sep) { @@ -113,7 +113,7 @@ QString BraceMatcher::insertMatchingBrace(const QTextCursor &cursor, } /*! - * Returns true if given character was added as one of character types. + * Returns true if the character \a c was added as one of character types. */ bool BraceMatcher::isKnownChar(const QChar c) const { diff --git a/src/libs/utils/completingtextedit.cpp b/src/libs/utils/completingtextedit.cpp index 77f061c7b4..1e44ef90f0 100644 --- a/src/libs/utils/completingtextedit.cpp +++ b/src/libs/utils/completingtextedit.cpp @@ -44,7 +44,7 @@ static bool isEndOfWordChar(const QChar &c) \brief The CompletingTextEdit class is a QTextEdit with auto-completion support. - Excerpted from Qt examples/tools/customcompleter + Excerpted from Qt examples/tools/customcompleter. */ namespace Utils { diff --git a/src/libs/utils/fancylineedit.cpp b/src/libs/utils/fancylineedit.cpp index 4df20ce614..d945852698 100644 --- a/src/libs/utils/fancylineedit.cpp +++ b/src/libs/utils/fancylineedit.cpp @@ -41,11 +41,10 @@ #include <QPropertyAnimation> #include <QStyle> -/*! Opens a menu at the specified widget position. - * This functions computes the position where to show the menu, and opens it with +/*! + * Opens \a menu at the specified \a widget position. + * This function computes the position where to show the menu, and opens it with * QMenu::exec(). - * \param menu The menu to open - * \param widget The widget next to which to open the menu */ static void execMenuAtWidget(QMenu *menu, QWidget *widget) { diff --git a/src/libs/utils/fileinprojectfinder.cpp b/src/libs/utils/fileinprojectfinder.cpp index fbf3d751e7..eb6b679c54 100644 --- a/src/libs/utils/fileinprojectfinder.cpp +++ b/src/libs/utils/fileinprojectfinder.cpp @@ -44,16 +44,15 @@ namespace Utils { \brief The FileInProjectFinder class is a helper class to find the \e original file in the project directory for a given file URL. - Often files are copied in the build + deploy process. findFile() searches for an existing file - in the project directory for a given file path: + Often files are copied in the build and deploy process. findFile() searches for an existing file + in the project directory for a given file path. - E.g. following file paths: + For example, the following file paths should all be mapped to + $PROJECTDIR/qml/app/main.qml: \list \li C:/app-build-desktop/qml/app/main.qml (shadow build directory) \li /Users/x/app-build-desktop/App.app/Contents/Resources/qml/App/main.qml (folder on Mac OS X) \endlist - - should all be mapped to $PROJECTDIR/qml/app/main.qml */ FileInProjectFinder::FileInProjectFinder() @@ -110,14 +109,14 @@ void FileInProjectFinder::setSysroot(const QString &sysroot) m_cache.clear(); } -/** - Returns the best match for the given file url in the project directory. +/*! + Returns the best match for the given file URL in the project directory. The method first checks whether the file inside the project directory exists. If not, the leading directory in the path is stripped, and the - now shorter - path is checked for existence, and so on. Second, it tries to locate the file in the sysroot folder specified. Third, we walk the list of project files, and search for a file name match - there. If all fails, it returns the original path from the file url. + there. If all fails, it returns the original path from the file URL. */ QString FileInProjectFinder::findFile(const QUrl &fileUrl, bool *success) const { diff --git a/src/libs/utils/filesystemwatcher.cpp b/src/libs/utils/filesystemwatcher.cpp index 2811f8c249..8110ce91bc 100644 --- a/src/libs/utils/filesystemwatcher.cpp +++ b/src/libs/utils/filesystemwatcher.cpp @@ -163,7 +163,7 @@ bool FileSystemWatcherPrivate::checkLimit() const } /*! - \brief Add to watcher 0. + Adds directories to watcher 0. */ FileSystemWatcher::FileSystemWatcher(QObject *parent) : @@ -173,7 +173,7 @@ FileSystemWatcher::FileSystemWatcher(QObject *parent) : } /*! - \brief Add to a watcher with specified id. + Adds directories to a watcher with the specified \a id. */ FileSystemWatcher::FileSystemWatcher(int id, QObject *parent) : diff --git a/src/libs/utils/fileutils.cpp b/src/libs/utils/fileutils.cpp index 7d004811a1..80ef5bc5ff 100644 --- a/src/libs/utils/fileutils.cpp +++ b/src/libs/utils/fileutils.cpp @@ -52,7 +52,7 @@ namespace Utils { \note The \a error parameter is optional. - \return Whether the operation succeeded. + Returns whether the operation succeeded. */ bool FileUtils::removeRecursively(const FileName &filePath, QString *error) { @@ -118,7 +118,7 @@ bool FileUtils::removeRecursively(const FileName &filePath, QString *error) \note The \a error parameter is optional. - \return Whether the operation succeeded. + Returns whether the operation succeeded. */ bool FileUtils::copyRecursively(const FileName &srcFilePath, const FileName &tgtFilePath, QString *error) @@ -162,7 +162,8 @@ bool FileUtils::copyRecursively(const FileName &srcFilePath, const FileName &tgt true if one of them is newer than \a timeStamp. If \a filePath is a single file, true will be returned if the file is newer than \a timeStamp. - \return Whether at least one file in \a filePath has a newer date than \a timeStamp. + Returns whether at least one file in \a filePath has a newer date than + \a timeStamp. */ bool FileUtils::isFileNewerThan(const FileName &filePath, const QDateTime &timeStamp) { @@ -181,13 +182,13 @@ bool FileUtils::isFileNewerThan(const FileName &filePath, const QDateTime &timeS } /*! - Recursively resolve possibly present symlinks in \a filePath. + Recursively resolves possibly present symlinks in \a filePath. Unlike QFileInfo::canonicalFilePath(), this function will still return the expected target file even if the symlink is dangling. \note Maximum recursion depth == 16. - return Symlink target file path. + Returns the symlink target file path. */ FileName FileUtils::resolveSymlinks(const FileName &path) { @@ -204,7 +205,7 @@ FileName FileUtils::resolveSymlinks(const FileName &path) Like QDir::toNativeSeparators(), but use prefix '~' instead of $HOME on unix systems when an absolute path is given. - return Possibly shortened path with native separators. + Returns the possibly shortened path with native separators. */ QString FileUtils::shortNativePath(const FileName &path) { diff --git a/src/libs/utils/json.cpp b/src/libs/utils/json.cpp index 5e12daabac..8a56f9c4a9 100644 --- a/src/libs/utils/json.cpp +++ b/src/libs/utils/json.cpp @@ -317,11 +317,12 @@ void JsonSchema::enterNestedPropertySchema(const QString &property) } /*! - * An array schema is allowed to have its *items* specification in the form of another schema + * An array schema is allowed to have its \e items specification in the form of + * another schema * or in the form of an array of schemas [Sec. 5.5]. This methods checks whether this is case * in which the items are a schema. * - * \return whether or not the items from the array are a schema + * Returns whether or not the items from the array are a schema. */ bool JsonSchema::hasItemSchema() const { @@ -338,11 +339,11 @@ void JsonSchema::enterNestedItemSchema() } /*! - * An array schema is allowed to have its *items* specification in the form of another schema + * An array schema is allowed to have its \e items specification in the form of another schema * or in the form of an array of schemas [Sec. 5.5]. This methods checks whether this is case * in which the items are an array of schemas. * - * \return whether or not the items from the array are a an array of schemas + * Returns whether or not the items from the array are a an array of schemas. */ bool JsonSchema::hasItemArraySchema() const { @@ -359,14 +360,16 @@ int JsonSchema::itemArraySchemaSize() const } /*! - * When evaluating the items of an array it might be necessary to "enter" a particular schema, + * When evaluating the items of an array it might be necessary to \e enter a + * particular schema, * since this API assumes that there's always a valid schema in context (the one the user is * interested on). This shall only happen if the item at the supplied array index is of type * object, which is then assumed to be a schema. * * The method also marks the context as being inside an array evaluation. * - * \return whether it was necessary to "enter" a schema for the supplied array index, false if index is out of bounds + * Returns whether it was necessary to enter a schema for the supplied + * array \a index, false if index is out of bounds. */ bool JsonSchema::maybeEnterNestedArraySchema(int index) { @@ -383,7 +386,7 @@ bool JsonSchema::maybeEnterNestedArraySchema(int index) * array of allowed types for the particular instance [Sec. 5.1]. This method checks whether * the current schema is one of such. * - * \return whether or not the current schema specifies a union type + * Returns whether or not the current schema specifies a union type. */ bool JsonSchema::hasUnionSchema() const { @@ -396,15 +399,16 @@ int JsonSchema::unionSchemaSize() const } /*! - * When evaluating union types it might be necessary to "enter" a particular schema, since this + * When evaluating union types it might be necessary to enter a particular + * schema, since this * API assumes that there's always a valid schema in context (the one the user is interested on). - * This shall only happen if the item at the supplied union index, which is then assumed to be + * This shall only happen if the item at the supplied union \a index, which is then assumed to be * a schema. * * The method also marks the context as being inside an union evaluation. * - * \param index - * \return whether or not it was necessary to "enter" a schema for the supplied union index + * Returns whether or not it was necessary to enter a schema for the + * supplied union index. */ bool JsonSchema::maybeEnterNestedUnionSchema(int index) { @@ -687,16 +691,13 @@ JsonSchemaManager::~JsonSchemaManager() } /*! - * \brief JsonManager::schemaForFile - * - * Try to find a JSON schema to which the supplied file can be validated against. According + * Tries to find a JSON schema to validate \a fileName against. According * to the specification, how the schema/instance association is done is implementation defined. * Currently we use a quite naive approach which is simply based on file names. Specifically, * if one opens a foo.json file we'll look for a schema named foo.json. We should probably * investigate alternative settings later. * - * \param fileName - JSON file to be validated - * \return a valid schema or 0 + * Returns a valid schema or 0. */ JsonSchema *JsonSchemaManager::schemaForFile(const QString &fileName) const { diff --git a/src/libs/utils/networkaccessmanager.cpp b/src/libs/utils/networkaccessmanager.cpp index 68f48420df..19b68fdf28 100644 --- a/src/libs/utils/networkaccessmanager.cpp +++ b/src/libs/utils/networkaccessmanager.cpp @@ -43,7 +43,7 @@ \brief The NetworkManager class provides a network access manager for use with \QC. - Common initialization, Qt Creator User Agent + Common initialization, \QC User Agent. Preferably, the instance returned by NetworkAccessManager::instance() should be used for the main thread. The constructor is provided only for multithreaded use. diff --git a/src/libs/utils/pathchooser.cpp b/src/libs/utils/pathchooser.cpp index 18e680e4ac..1b434d7adc 100644 --- a/src/libs/utils/pathchooser.cpp +++ b/src/libs/utils/pathchooser.cpp @@ -50,7 +50,7 @@ consisting of a QLineEdit and a "Browse" button. - Has some validation logic for embedding into QWizardPage. + This class has some validation logic for embedding into QWizardPage. */ const char * const Utils::PathChooser::browseButtonLabel = diff --git a/src/libs/utils/projectintropage.cpp b/src/libs/utils/projectintropage.cpp index 7f2579840b..e7b12675da 100644 --- a/src/libs/utils/projectintropage.cpp +++ b/src/libs/utils/projectintropage.cpp @@ -42,13 +42,13 @@ Looks similar to FileWizardPage, but provides additional functionality: \list - \li Description label at the top for displaying introductory text - \li It does on the fly validation (connected to changed()) and displays - warnings/errors in a status label at the bottom (the page is complete + \li Contains a description label at the top for displaying introductory text. + \li Does on the fly validation (connected to changed()) and displays + warnings and errors in a status label at the bottom (the page is complete when fully validated, validatePage() is thus not implemented). \endlist - Note: Careful when changing projectintropage.ui. It must have main + \note Careful when changing projectintropage.ui. It must have main geometry cleared and QLayout::SetMinimumSize constraint on the main layout, otherwise, QWizard will squeeze it due to its strange expanding hacks. diff --git a/src/libs/utils/qtcprocess.cpp b/src/libs/utils/qtcprocess.cpp index 88c82cef68..1897a2846a 100644 --- a/src/libs/utils/qtcprocess.cpp +++ b/src/libs/utils/qtcprocess.cpp @@ -200,14 +200,14 @@ static QStringList doSplitArgs(const QString &args, QtcProcess::SplitError *err) } /*! - Splits \a args according to system shell word splitting and quoting rules. + Splits \a _args according to system shell word splitting and quoting rules. \section1 Unix The behavior is based on the POSIX shell and bash: \list - \li Whitespace splits tokens - \li The backslash quotes the following character + \li Whitespace splits tokens. + \li The backslash quotes the following character. \li A string enclosed in single quotes is not split. No shell meta characters are interpreted. \li A string enclosed in double quotes is not split. Within the string, @@ -219,17 +219,25 @@ static QStringList doSplitArgs(const QString &args, QtcProcess::SplitError *err) If \a abortOnMeta is \c true, encounters of unhandled meta characters are treated as errors. + If \a err is not NULL, stores a status code at the pointer target. For more + information, see \l SplitError. + + If \env is not NULL, performs variable substitution with the + given environment. + + Returns a list of unquoted words or an empty list if an error occurred. + \section1 Windows The behavior is defined by the Microsoft C runtime: \list - \li Whitespace splits tokens - \li A string enclosed in double quotes is not split + \li Whitespace splits tokens. + \li A string enclosed in double quotes is not split. \list \li 3N double quotes within a quoted string yield N literal quotes. This is not documented on MSDN. \endlist - \li Backslashes have special semantics iff they are followed by a double quote: + \li Backslashes have special semantics if they are followed by a double quote: \list \li 2N backslashes + double quote => N backslashes and begin/end quoting \li 2N+1 backslashes + double quote => N backslashes + literal quote @@ -248,14 +256,6 @@ static QStringList doSplitArgs(const QString &args, QtcProcess::SplitError *err) As the quoting levels are independent from each other and have different semantics, you need a command line like \c{"foo "\^"" bar"} to get \c{foo " bar}. - - \param cmd the command to split - \param abortOnMeta see above - \param err if not NULL, a status code will be stored at the pointer - target, see \l SplitError - \param env if not NULL, perform variable substitution with the - given environment. - \return a list of unquoted words or an empty list if an error occurred */ QStringList QtcProcess::splitArgs(const QString &_args, bool abortOnMeta, SplitError *err, diff --git a/src/libs/utils/tcpportsgatherer.cpp b/src/libs/utils/tcpportsgatherer.cpp index 0f56da91e6..a346b34548 100644 --- a/src/libs/utils/tcpportsgatherer.cpp +++ b/src/libs/utils/tcpportsgatherer.cpp @@ -250,7 +250,8 @@ void TcpPortsGathererPrivate::updateNetstat() \brief The TcpPortsGatherer class gathers the list of local TCP ports already in use. - Query the system for the list of local TCP ports already in use. This information can be used + Queries the system for the list of local TCP ports already in use. This + information can be used to select a port for use in a range. */ @@ -283,7 +284,7 @@ QList<int> TcpPortsGatherer::usedPorts() const } /*! - Select a port out of \a freePorts that is not yet used. + Selects a port out of \a freePorts that is not yet used. Returns the port, or -1 if no free port is available. */ diff --git a/src/libs/utils/textfileformat.cpp b/src/libs/utils/textfileformat.cpp index 26dac75df3..bbd90e7a8a 100644 --- a/src/libs/utils/textfileformat.cpp +++ b/src/libs/utils/textfileformat.cpp @@ -78,7 +78,7 @@ TextFileFormat::TextFileFormat() : } /*! - \brief Detect the format of text data. + Detects the format of text data. */ TextFileFormat TextFileFormat::detect(const QByteArray &data) @@ -111,7 +111,7 @@ TextFileFormat TextFileFormat::detect(const QByteArray &data) } /*! - \brief Returns a piece of text suitable as display for a encoding error. + Returns a piece of text suitable as display for a encoding error. */ QByteArray TextFileFormat::decodingErrorSample(const QByteArray &data) @@ -179,7 +179,7 @@ bool decodeTextFileContent(const QByteArray &dataBA, } /*! - \brief Decode data to a plain string. + Decodes data to a plain string. */ bool TextFileFormat::decode(const QByteArray &data, QString *target) const @@ -189,7 +189,7 @@ bool TextFileFormat::decode(const QByteArray &data, QString *target) const } /*! - \brief Decode data to a list of strings. + Decodes data to a list of strings. Intended for use with progress bars loading large files. */ @@ -236,7 +236,7 @@ TextFileFormat::ReadResult readTextFile(const QString &fileName, const QTextCode } /*! - \brief Read text file into a list of strings. + Reads a text file into a list of strings. */ TextFileFormat::ReadResult @@ -254,7 +254,7 @@ TextFileFormat::ReadResult } /*! - \brief Read text file into a string. + Reads a text file into a string. */ TextFileFormat::ReadResult @@ -305,7 +305,7 @@ TextFileFormat::ReadResult TextFileFormat::readFileUTF8(const QString &fileName, } /*! - \brief Write out a text file. + Writes out a text file. */ bool TextFileFormat::writeFile(const QString &fileName, QString plainText, QString *errorString) const diff --git a/src/libs/zeroconf/servicebrowser.cpp b/src/libs/zeroconf/servicebrowser.cpp index 40c7572061..0e6f26eeab 100644 --- a/src/libs/zeroconf/servicebrowser.cpp +++ b/src/libs/zeroconf/servicebrowser.cpp @@ -395,7 +395,7 @@ QDebug operator<<(QDebug dbg, const Service::ConstPtr &service){ /*! \fn bool Service::outdated() const - Returns if the service data is outdated, its value might change even on + Returns whether the service data is outdated. Its value might change even on the (otherwise constant) objects returned by a ServiceBrowser. */ /*! @@ -421,7 +421,7 @@ QDebug operator<<(QDebug dbg, const Service::ConstPtr &service){ /*! \fn QString Service::port() const - Return the port of the service (as a string, not as number). + Returns the port of the service (as a string, not as number). */ /*! \fn const Service::ServiceTxtRecord &txtRecord() const @@ -436,7 +436,8 @@ QDebug operator<<(QDebug dbg, const Service::ConstPtr &service){ /*! \fn int Service::interfaceNr() const - returns the interface on which the service is reachable, 1 based, 0 means to try all interfaces + Returns the interface on which the service is reachable, 1 based, 0 means to + try all interfaces. */ /*! \fn bool Service::invalidate() @@ -452,7 +453,7 @@ QDebug operator<<(QDebug dbg, const Service::ConstPtr &service){ service. The actual browsing starts only when startBrowsing() is called. If you want to receive all service - changes connect before starting browsing. + changes, connect before starting browsing. The current list of services can be gathered with the services() method. @@ -573,23 +574,23 @@ void ServiceBrowser::autoRefresh() \fn void ServiceBrowser::serviceChanged( Service::ConstPtr oldService, Service::ConstPtr newService, ServiceBrowser *browser) - This signal is called when a service is added removed or changes. + This signal is called when a service is added, removed, or changed. Both oldService or newService might be null (covers both add and remove). The services list might not be synchronized with respect to this signal. */ /*! \fn void ServiceBrowser::serviceAdded(Service::ConstPtr service, ServiceBrowser *browser) - This signal is called when a service is added (convenience method) - the services list might not be synchronized with respect to this signal + This signal is called when a service is added (convenience method). + The services list might not be synchronized with respect to this signal. \sa serviceChanged() */ /*! \fn void ServiceBrowser::serviceRemoved(Service::ConstPtr service, ServiceBrowser *browser) - This signal is called when a service is removed (convenience method) - the services list might not be synchronized with respect to this signal + This signal is called when a service is removed (convenience method). + The services list might not be synchronized with respect to this signal. \sa serviceChanged() */ @@ -597,8 +598,9 @@ void ServiceBrowser::autoRefresh() \fn void ServiceBrowser::servicesUpdated(ServiceBrowser *browser) This signal is called when the list is updated. - It might collect several serviceChanged signals together, if you use the list returned by - services(), use this signal, not serviceChanged(), serviceAdded() or serviceRemoved() to know + It might collect several serviceChanged signals together. If you use the list + returned by services(), use this signal, not serviceChanged(), serviceAdded(), + or serviceRemoved() to learn about changes to the list. */ /*! diff --git a/src/plugins/bineditor/markup.cpp b/src/plugins/bineditor/markup.cpp new file mode 100644 index 0000000000..cae1cf5914 --- /dev/null +++ b/src/plugins/bineditor/markup.cpp @@ -0,0 +1,41 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of Qt Creator. +** +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Digia gives you certain additional +** rights. These rights are described in the Digia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +****************************************************************************/ + +#include "markup.h" + +/*! + \class BINEditor::Markup + \brief The Markup class defines the range of the binary editor. + + Used for displaying class layouts by the debugger. + + \note Must not have linkage - used for soft dependencies. + + \sa Debugger::Internal::MemoryAgent +*/ diff --git a/src/plugins/bineditor/markup.h b/src/plugins/bineditor/markup.h index 8e4bd767df..2b5b0e45b7 100644 --- a/src/plugins/bineditor/markup.h +++ b/src/plugins/bineditor/markup.h @@ -36,16 +36,6 @@ #include <QMetaType> namespace BINEditor { -/*! - \class BINEditor::Markup - \brief Markup range of the binary editor. - - Used for displaying class layouts by the debugger. - - \note Must not have linkage - used for soft dependencies. - - \sa Debugger::Internal::MemoryAgent -*/ class Markup { diff --git a/src/plugins/coreplugin/actionmanager/actionmanager.cpp b/src/plugins/coreplugin/actionmanager/actionmanager.cpp index 5eb2161db7..3bf3d902ca 100644 --- a/src/plugins/coreplugin/actionmanager/actionmanager.cpp +++ b/src/plugins/coreplugin/actionmanager/actionmanager.cpp @@ -170,7 +170,7 @@ ActionManager *ActionManager::instance() } /*! - \brief Creates a new menu with the given \a id. + Creates a new menu with the given \a id. Returns a new ActionContainer that you can use to get the QMenu instance or to add menu items to the menu. The ActionManager owns @@ -197,7 +197,7 @@ ActionContainer *ActionManager::createMenu(Id id) } /*! - \brief Creates a new menu bar with the given \a id. + Creates a new menu bar with the given \a id. Returns a new ActionContainer that you can use to get the QMenuBar instance or to add menus to the menu bar. The ActionManager owns @@ -222,7 +222,7 @@ ActionContainer *ActionManager::createMenuBar(Id id) } /*! - \brief Makes an \a action known to the system under the specified \a id. + Makes an \a action known to the system under the specified \a id. Returns a command object that represents the action in the application and is owned by the ActionManager. You can register several actions with the @@ -244,7 +244,7 @@ Command *ActionManager::registerAction(QAction *action, Id id, const Context &co } /*! - \brief Makes a \a shortcut known to the system under the specified \a id. + Makes a \a shortcut known to the system under the specified \a id. Returns a command object that represents the shortcut in the application and is owned by the ActionManager. You can registered several shortcuts with the @@ -293,7 +293,7 @@ Command *ActionManager::registerShortcut(QShortcut *shortcut, Id id, const Conte } /*! - \brief Returns the Command object that is known to the system + Returns the Command object that is known to the system under the given \a id. \sa ActionManager::registerAction() @@ -311,7 +311,7 @@ Command *ActionManager::command(Id id) } /*! - \brief Returns the IActionContainter object that is know to the system + Returns the IActionContainter object that is know to the system under the given \a id. \sa ActionManager::createMenu() @@ -330,7 +330,7 @@ ActionContainer *ActionManager::actionContainer(Id id) } /*! - * \brief Returns all commands that have been registered. + * Returns all commands that have been registered. */ QList<Command *> ActionManager::commands() { @@ -342,7 +342,7 @@ QList<Command *> ActionManager::commands() } /*! - \brief Removes the knowledge about an \a action under the specified \a id. + Removes the knowledge about an \a action under the specified \a id. Usually you do not need to unregister actions. The only valid use case for unregistering actions, is for actions that represent user definable actions, like for the custom Locator @@ -373,7 +373,7 @@ void ActionManager::unregisterAction(QAction *action, Id id) } /*! - \brief Removes the knowledge about a shortcut under the specified \a id. + Removes the knowledge about a shortcut under the specified \a id. Usually you do not need to unregister shortcuts. The only valid use case for unregistering shortcuts, is for shortcuts that represent user definable actions. If the user removes such an action, diff --git a/src/plugins/coreplugin/actionmanager/command.cpp b/src/plugins/coreplugin/actionmanager/command.cpp index 2646b091c8..b7b2eb0300 100644 --- a/src/plugins/coreplugin/actionmanager/command.cpp +++ b/src/plugins/coreplugin/actionmanager/command.cpp @@ -44,13 +44,13 @@ \class Core::Command \mainclass - \brief The class Command represents an action like a menu item, tool button, or shortcut. - You don't create Command objects directly, instead use \l{ActionManager::registerAction()} + \brief The Command class represents an action, such as a menu item, tool button, or shortcut. + You do not create Command objects directly, but use \l{ActionManager::registerAction()} to register an action and retrieve a Command. The Command object represents the user visible action and its properties. If multiple actions are registered with the same ID (but different contexts) the returned Command is the shared one between these actions. - A Command has two basic properties: A default shortcut and a default text. The default + A Command has two basic properties: a default shortcut and a default text. The default shortcut is a key sequence that the user can use to trigger the active action that the Command represents. The default text is e.g. used for representing the Command in the keyboard shortcut preference pane. If the default text is empty, the text @@ -68,7 +68,7 @@ /*! \enum Command::CommandAttribute - Defines how the user visible action is updated when the active action changes. + This enum defines how the user visible action is updated when the active action changes. The default is to update the enabled and visible state, and to disable the user visible action when there is no active action. \omitvalue CA_Mask @@ -86,7 +86,7 @@ /*! \fn void Command::setDefaultKeySequence(const QKeySequence &key) - Set the default keyboard shortcut that can be used to activate this command to \a key. + Sets the default keyboard shortcut that can be used to activate this command to \a key. This is used if the user didn't customize the shortcut, or resets the shortcut to the default one. */ @@ -116,10 +116,10 @@ /*! \fn void Command::setDescription(const QString &text) - Set the \a text that is used to represent the Command in the - keyboard shortcut settings dialog. If you don't set this, + Sets the \a text that is used to represent the Command in the + keyboard shortcut settings dialog. If you do not set this, the current text from the user visible action is taken (which - is ok in many cases). + is fine in many cases). */ /*! @@ -160,7 +160,7 @@ /*! \fn void Command::setAttribute(CommandAttribute attribute) - Add the \a attribute to the attributes of this Command. + Adds \a attribute to the attributes of this Command. \sa CommandAttribute \sa removeAttribute() \sa hasAttribute() @@ -168,14 +168,14 @@ /*! \fn void Command::removeAttribute(CommandAttribute attribute) - Remove the \a attribute from the attributes of this Command. + Removes \a attribute from the attributes of this Command. \sa CommandAttribute \sa setAttribute() */ /*! \fn bool Command::hasAttribute(CommandAttribute attribute) const - Returns if the Command has the \a attribute set. + Returns whether the Command has the \a attribute set. \sa CommandAttribute \sa removeAttribute() \sa setAttribute() @@ -183,19 +183,19 @@ /*! \fn bool Command::isActive() const - Returns if the Command has an active action/shortcut for the current + Returns whether the Command has an active action or shortcut for the current context. */ /*! \fn bool Command::isScriptable() const - Returns if the Command is scriptable. A scriptable command can be called + Returns whether the Command is scriptable. A scriptable command can be called from a script without the need for the user to interact with it. */ /*! \fn bool Command::isScriptable(const Context &) const - Returns if the Command is scriptable for the given context. + Returns whether the Command is scriptable for the given context. A scriptable command can be called from a script without the need for the user to interact with it. */ diff --git a/src/plugins/coreplugin/basefilewizard.cpp b/src/plugins/coreplugin/basefilewizard.cpp index 1d1167943b..eb11eba5c1 100644 --- a/src/plugins/coreplugin/basefilewizard.cpp +++ b/src/plugins/coreplugin/basefilewizard.cpp @@ -65,9 +65,10 @@ static int indexOfFile(const GeneratedFiles &f, const QString &path) /*! \class Core::Internal::WizardEventLoop - \brief Special event loop that runs a QWizard and terminates if the page changes. + \brief The WizardEventLoop class implements a special event + loop that runs a QWizard and terminates if the page changes. - Use by Core::BaseFileWizard to intercept the change from the standard wizard pages + Used by Core::BaseFileWizard to intercept the change from the standard wizard pages to the extension pages (as the latter require the list of Core::GeneratedFile generated). Synopsis: @@ -162,13 +163,12 @@ void WizardEventLoop::rejected() \brief The BaseFileWizard class implements a generic wizard for creating files. - The abstract methods: + The following abstract methods must be implemented: \list - \li createWizardDialog(): Called to create the QWizard dialog to be shown - \li generateFiles(): Generate file content + \li createWizardDialog(): Called to create the QWizard dialog to be shown. + \li generateFiles(): Generates file content. \endlist - must be implemented. The behaviour can be further customized by overwriting the virtual method \c postGenerateFiles(), which is called after generating the files. @@ -311,19 +311,22 @@ void BaseFileWizard::runWizard(const QString &path, QWidget *parent, const QStri /*! \fn virtual QWizard *Core::BaseFileWizard::createWizardDialog(QWidget *parent, const WizardDialogParameters &wizardDialogParameters) const - \brief Implement to create the wizard dialog on the parent, adding the extension pages. + + Creates the wizard dialog on the \a parent with the + \a wizardDialogParameters. */ /*! \fn virtual Core::GeneratedFiles Core::BaseFileWizard::generateFiles(const QWizard *w, QString *errorMessage) const = 0 - \brief Overwrite to query the parameters from the dialog and generate the files. + Overwrite to query the parameters from the dialog and generate the files. - Note: This does not generate physical files, but merely the list of Core::GeneratedFile. + \note This does not generate physical files, but merely the list of + Core::GeneratedFile. */ /*! - \brief Physically write files. + Physically writes files. Re-implement (calling the base implementation) to create files with CustomGeneratorAttribute set. */ @@ -340,7 +343,7 @@ bool BaseFileWizard::writeFiles(const GeneratedFiles &files, QString *errorMessa } /*! - \brief Sets some standard options on a QWizard + Sets some standard options on a QWizard. */ void BaseFileWizard::setupWizard(QWizard *w) @@ -362,8 +365,8 @@ void BaseFileWizard::setupWizard(QWizard *w) } /*! - \brief Read "shortTitle" dynamic property of the pageId and apply it as the title - of corresponding progress item + Reads the \c shortTitle dynamic property of \a pageId and applies it as + the title of corresponding progress item. */ void BaseFileWizard::applyExtensionPageShortTitle(Utils::Wizard *wizard, int pageId) @@ -382,7 +385,7 @@ void BaseFileWizard::applyExtensionPageShortTitle(Utils::Wizard *wizard, int pag } /*! - \brief Overwrite to perform steps to be done after files are actually created. + Overwrite to perform steps to be done after files are actually created. The default implementation opens editors with the newly generated files. */ @@ -393,7 +396,7 @@ bool BaseFileWizard::postGenerateFiles(const QWizard *, const GeneratedFiles &l, } /*! - \brief Utility to open the editors for the files whose attribute is set accordingly. + Opens the editors for the files whose attribute is set accordingly. */ bool BaseFileWizard::postGenerateOpenEditors(const GeneratedFiles &l, QString *errorMessage) @@ -411,8 +414,8 @@ bool BaseFileWizard::postGenerateOpenEditors(const GeneratedFiles &l, QString *e } /*! - \brief Utility that performs an overwrite check on a set of files. It checks if - the file exists, can be overwritten at all and prompts the user with a summary. + Performs an overwrite check on a set of \a files. Checks if the file exists and + can be overwritten at all, and then prompts the user with a summary. */ BaseFileWizard::OverwriteResult BaseFileWizard::promptOverwrite(GeneratedFiles *files, @@ -493,7 +496,8 @@ BaseFileWizard::OverwriteResult BaseFileWizard::promptOverwrite(GeneratedFiles * } /*! - \brief Build a file name, adding the extension unless baseName already has one. + Constructs a file name, adding the \a extension unless \a baseName already has + one. */ QString BaseFileWizard::buildFileName(const QString &path, @@ -517,7 +521,7 @@ QString BaseFileWizard::buildFileName(const QString &path, } /*! - \brief Utility that returns the preferred suffix for a mime type + Returns the preferred suffix for \a mimeType. */ QString BaseFileWizard::preferredSuffix(const QString &mimeType) @@ -545,7 +549,7 @@ QString BaseFileWizard::preferredSuffix(const QString &mimeType) \fn Core::GeneratedFiles Core::StandardFileWizard::generateFilesFromPath(const QString &path, const QString &name, QString *errorMessage) const = 0 - \brief Newly introduced virtual that creates the files under the path. + Creates the files with the \a name under the \a path. */ StandardFileWizard::StandardFileWizard(QObject *parent) : @@ -554,7 +558,7 @@ StandardFileWizard::StandardFileWizard(QObject *parent) : } /*! - \brief Implemented to create a Utils::FileWizardDialog. + Creates a Utils::FileWizardDialog. */ QWizard *StandardFileWizard::createWizardDialog(QWidget *parent, @@ -572,7 +576,7 @@ QWizard *StandardFileWizard::createWizardDialog(QWidget *parent, } /*! - \brief Implemented to retrieve path and name and call generateFilesFromPath() + Retrieves \a path and \a fileName and calls \c generateFilesFromPath(). */ GeneratedFiles StandardFileWizard::generateFiles(const QWizard *w, diff --git a/src/plugins/coreplugin/coreplugin.pro b/src/plugins/coreplugin/coreplugin.pro index 6f283d19ac..10b4087a43 100644 --- a/src/plugins/coreplugin/coreplugin.pro +++ b/src/plugins/coreplugin/coreplugin.pro @@ -95,7 +95,8 @@ SOURCES += mainwindow.cpp \ documentmanager.cpp \ removefiledialog.cpp \ iversioncontrol.cpp \ - dialogs/addtovcsdialog.cpp + dialogs/addtovcsdialog.cpp \ + icorelistener.cpp HEADERS += mainwindow.h \ editmode.h \ diff --git a/src/plugins/coreplugin/coreplugin.qbs b/src/plugins/coreplugin/coreplugin.qbs index 16b8c5cb78..fc2dc19c81 100644 --- a/src/plugins/coreplugin/coreplugin.qbs +++ b/src/plugins/coreplugin/coreplugin.qbs @@ -48,7 +48,7 @@ QtcPlugin { "helpmanager.cpp", "helpmanager.h", "icontext.cpp", "icontext.h", "icore.cpp", "icore.h", - "icorelistener.h", + "icorelistener.cpp", "icorelistener.h", "id.cpp", "id.h", "idocument.cpp", "idocument.h", "idocumentfactory.h", diff --git a/src/plugins/coreplugin/dialogs/ioptionspage.cpp b/src/plugins/coreplugin/dialogs/ioptionspage.cpp index 34f1de78a2..12ad324c7b 100644 --- a/src/plugins/coreplugin/dialogs/ioptionspage.cpp +++ b/src/plugins/coreplugin/dialogs/ioptionspage.cpp @@ -39,15 +39,16 @@ into the plugin manager object pool (e.g. ExtensionSystem::PluginManager::addObject). Guidelines for implementing: \list - \li id() is a unique identifier for referencing this page - \li displayName() is the (translated) name for display - \li category() is the unique id for the category that the page should be displayed in - \li displayCategory() is the translated name of the category - \li createPage() is called to retrieve the widget to show in the preferences dialog + \li \c id() is a unique identifier for referencing this page + \li \c displayName() is the (translated) name for display + \li \c category() is the unique id for the category that the page should be displayed in + \li \c displayCategory() is the translated name of the category + \li \c createPage() is called to retrieve the widget to show in the + \gui Options dialog The widget will be destroyed by the widget hierarchy when the dialog closes - \li apply() is called to store the settings. It should detect if any changes have been + \li \c apply() is called to store the settings. It should detect if any changes have been made and store those - \li finish() is called directly before the preferences dialog closes - \li matches() is used for the options dialog search filter + \li \c finish() is called directly before the \gui Options dialog closes + \li \c matches() is used for the \gui Options dialog search filter \endlist */ diff --git a/src/plugins/coreplugin/dialogs/readonlyfilesdialog.cpp b/src/plugins/coreplugin/dialogs/readonlyfilesdialog.cpp index 429ebf7859..3a017e8c52 100644 --- a/src/plugins/coreplugin/dialogs/readonlyfilesdialog.cpp +++ b/src/plugins/coreplugin/dialogs/readonlyfilesdialog.cpp @@ -158,7 +158,7 @@ ReadOnlyFilesDialog::~ReadOnlyFilesDialog() } /*! - * \brief Set a user defined message in the dialog. + * Sets a user defined message in the dialog. * \internal */ void ReadOnlyFilesDialog::setMessage(const QString &message) @@ -167,8 +167,8 @@ void ReadOnlyFilesDialog::setMessage(const QString &message) } /*! - * \brief Enable the error output to the user via a messageBox. - * \param warning Added to the dialog, should show possible consequences if the file is still read only. + * Enables the error output to the user via a message box. \a warning should + * show the possible consequences if the file is still read only. * \internal */ void ReadOnlyFilesDialog::setShowFailWarning(bool show, const QString &warning) @@ -178,7 +178,7 @@ void ReadOnlyFilesDialog::setShowFailWarning(bool show, const QString &warning) } /*! - * \brief Opens a message box with an error description according to the type. + * Opens a message box with an error description according to the type. * \internal */ void ReadOnlyFilesDialog::promptFailWarning(const QStringList &files, ReadOnlyResult type) const @@ -237,12 +237,13 @@ void ReadOnlyFilesDialog::promptFailWarning(const QStringList &files, ReadOnlyRe } /*! - * \brief Executes the dialog. - * \return ReadOnlyResult which gives information about the operation which was used to make the files writable. + * Executes the ReadOnlyFilesDialog dialog. + * Returns ReadOnlyResult to provide information about the operation that was + * used to make the files writable. * \internal * - * Also displays an error dialog when some operations can't be executed and the function - * setShowFailWarning was called. + * Also displays an error dialog when some operations cannot be executed and the + * function \c setShowFailWarning() was called. */ int ReadOnlyFilesDialog::exec() { @@ -287,9 +288,9 @@ int ReadOnlyFilesDialog::exec() } /*! - * \brief Creates a radio button in the column specified with type. - * \param group the created button will be added to this group. - * \return the created button. + * Creates a radio button in the group \a group and in the column specified by + * \a type. + * Returns the created button. * \internal */ QRadioButton* ReadOnlyFilesDialog::createRadioButtonForItem(QTreeWidgetItem *item, QButtonGroup *group, @@ -304,7 +305,8 @@ QRadioButton* ReadOnlyFilesDialog::createRadioButtonForItem(QTreeWidgetItem *ite } /*! - * \brief Checks the type of the select all combo box and change the user selection per file accordingly. + * Checks the type of the select all combo box and changes the user selection + * per file accordingly. * \internal */ void ReadOnlyFilesDialog::setAll(int index) @@ -331,7 +333,8 @@ void ReadOnlyFilesDialog::setAll(int index) } /*! - * \brief Updates the select all combo box depending on the selection in the tree widget the user made. + * Updates the select all combo box depending on the selection the user made in + * the tree widget. * \internal */ void ReadOnlyFilesDialog::updateSelectAll() @@ -349,8 +352,10 @@ void ReadOnlyFilesDialog::updateSelectAll() } /*! - * \brief Adds files to the dialog and check for possible operation to make the file writable. - * \param fileNames A List of files which should be added to the dialog. + * Adds files to the dialog and checks for a possible operation to make the file + * writable. + * \a fileNames contains the list of the files that should be added to the + * dialog. * \internal */ void ReadOnlyFilesDialog::initDialog(const QStringList &fileNames) diff --git a/src/plugins/coreplugin/documentmanager.cpp b/src/plugins/coreplugin/documentmanager.cpp index dd9b1b5e3e..e7c2573e5a 100644 --- a/src/plugins/coreplugin/documentmanager.cpp +++ b/src/plugins/coreplugin/documentmanager.cpp @@ -66,27 +66,29 @@ \inheaderfile documentmanager.h \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 - monitored at filesystem level. If a file changes, the status of the IDocument's + The DocumentManager service monitors a set of IDocument objects. Plugins + should register files they work with at the service. The files the IDocument + objects point to will be monitored at filesystem level. If a file changes, + the status of the IDocument object will be adjusted accordingly. Furthermore, on application exit the user will be asked to save all modified files. Different IDocument objects in the set can point to the same file in the - filesystem. The monitoring for a IDocument can be blocked by blockFileChange(), and - enabled again by unblockFileChange(). + filesystem. The monitoring for an IDocument can be blocked by + \c blockFileChange(), and enabled again by \c unblockFileChange(). - The functions expectFileChange() and unexpectFileChange() mark a file change + The functions \c expectFileChange() and \c unexpectFileChange() mark a file change as expected. On expected file changes all IDocument objects are notified to reload themselves. The DocumentManager service also provides two convenience methods for saving - files: saveModifiedFiles() and saveModifiedFilesSilently(). Both take a list + files: \c saveModifiedFiles() and \c saveModifiedFilesSilently(). Both take a list of FileInterfaces as an argument, and return the list of files which were _not_ saved. - The service also manages the list of recent files to be shown to the user - (see addToRecentFiles() and recentFiles()). + The service also manages the list of recent files to be shown to the user. + + \sa addToRecentFiles(), recentFiles() */ static const char settingsGroupC[] = "RecentFiles"; @@ -156,7 +158,7 @@ struct DocumentManagerPrivate QString m_projectsDirectory; bool m_useProjectsDirectory; QString m_buildDirectory; - // When we are callling into a IDocument + // When we are calling into an IDocument // we don't want to receive a changed() // signal // That makes the code easier @@ -359,12 +361,13 @@ static void dump() */ /*! - \brief Tells the file manager that a file has been renamed on disk from within Qt Creator. + Tells the file manager that a file has been renamed on disk from within \QC. - Needs to be called right after the actual renaming on disk (i.e. before the file system + Needs to be called right after the actual renaming on disk (that is, before + the file system watcher can report the event during the next event loop run). \a from needs to be an absolute file path. This will notify all IDocument objects pointing to that file of the rename - by calling IDocument::rename, and update the cached time and permission + by calling \c IDocument::rename(), and update the cached time and permission information to avoid annoying the user with "file has been removed" popups. */ @@ -402,7 +405,8 @@ void DocumentManager::filePathChanged(const QString &oldName, const QString &new } /*! - Adds a IDocument object to the collection. If \a addWatcher is true (the default), + Adds an IDocument object to the collection. If \a addWatcher is \c true + (the default), the file is added to a file system watcher that notifies the file manager about file changes. */ @@ -420,9 +424,10 @@ void DocumentManager::documentDestroyed(QObject *obj) } /*! - Removes a IDocument object from the collection. + Removes an IDocument object from the collection. - Returns true if the file specified by \a document had the addWatcher argument to addDocument() set. + Returns \c true if the file specified by \a document had the \a addWatcher + argument to \a addDocument() set. */ bool DocumentManager::removeDocument(IDocument *document) { @@ -481,7 +486,7 @@ QString DocumentManager::fixFileName(const QString &fileName, FixMode fixmode) } /*! - Returns the list of IDocument's that have been modified. + Returns the list of IDocuments that have been modified. */ QList<IDocument *> DocumentManager::modifiedDocuments() { @@ -501,7 +506,7 @@ QList<IDocument *> DocumentManager::modifiedDocuments() } /*! - Any subsequent change to \a fileName is treated as a expected file change. + Any subsequent change to \a fileName is treated as an expected file change. \see DocumentManager::unexpectFileChange(const QString &fileName) */ @@ -525,7 +530,7 @@ static void updateExpectedState(const QString &fileName) } /*! - Any change to \a fileName are unexpected again. + Any changes to \a fileName are unexpected again. \see DocumentManager::expectFileChange(const QString &fileName) */ @@ -550,7 +555,8 @@ void DocumentManager::unexpectFileChange(const QString &fileName) /*! Tries to save the files listed in \a documents. The \a cancelled argument is set to true if the user cancelled the dialog. Returns the files that could not be saved. If the files - listed in documents have no write permissions an additional dialog will be prompted to + listed in documents have no write permissions, an additional dialog will be + displayed to query the user for these permissions. */ QList<IDocument *> DocumentManager::saveModifiedDocumentsSilently(const QList<IDocument *> &documents, bool *cancelled) @@ -559,14 +565,17 @@ QList<IDocument *> DocumentManager::saveModifiedDocumentsSilently(const QList<ID } /*! - Asks the user whether to save the files listed in \a documents . - Opens a dialog with the given \a message, and a additional - text that should be used to ask if the user wants to enabled automatic save + Asks the user whether to save the files listed in \a documents. Opens a + dialog that displays the \a message, and additional text to ask the users + if they want to enable automatic saving of modified files (in this context). - The \a cancelled argument is set to true if the user cancelled the dialog, - \a alwaysSave is set to match the selection of the user, if files should + + The \a cancelled argument is set to true if the user cancels the dialog. + \a alwaysSave is set to match the selection of the user if files should always automatically be saved. If the files listed in documents have no write - permissions an additional dialog will be prompted to query the user for these permissions. + permissions, an additional dialog will be displayed to query the user for + these permissions. + Returns the files that have not been saved. */ QList<IDocument *> DocumentManager::saveModifiedDocuments(const QList<IDocument *> &documents, @@ -740,7 +749,7 @@ QString DocumentManager::getSaveFileNameWithExtension(const QString &title, cons } /*! - Asks the user for a new file name (Save File As) for /arg document. + Asks the user for a new file name (\gui {Save File As}) for \a document. */ QString DocumentManager::getSaveAsFileName(const IDocument *document, const QString &filter, QString *selectedFilter) { @@ -775,9 +784,9 @@ QString DocumentManager::getSaveAsFileName(const IDocument *document, const QStr /*! Asks the user for a set of file names to be opened. The \a filters - and \a selectedFilter parameters is interpreted like in - QFileDialog::getOpenFileNames(), \a pathIn specifies a path to open the dialog - in, if that is not overridden by the users policy. + and \a selectedFilter arguments are interpreted like in + \c QFileDialog::getOpenFileNames(). \a pathIn specifies a path to open the + dialog in if that is not overridden by the user's policy. */ QStringList DocumentManager::getOpenFileNames(const QString &filters, @@ -1055,8 +1064,8 @@ void DocumentManager::syncWithEditor(const QList<Core::IContext *> &context) /*! Adds the \a fileName to the list of recent files. Associates the file to - be reopened with an editor of the given \a editorId, if possible. - \a editorId defaults to the empty id, which means to let the system figure out + be reopened with the editor that has the specified \a editorId, if possible. + \a editorId defaults to the empty id, which lets \QC figure out the best editor itself. */ void DocumentManager::addToRecentFiles(const QString &fileName, const Id &editorId) @@ -1078,7 +1087,7 @@ void DocumentManager::addToRecentFiles(const QString &fileName, const Id &editor /*! Clears the list of recent files. Should only be called by - the core plugin when the user chooses to clear it. + the core plugin when the user chooses to clear the list. */ void DocumentManager::clearRecentFiles() { @@ -1155,8 +1164,8 @@ void readSettings() /*! - The current file is e.g. the file currently opened when an editor is active, - or the selected file in case a Project Explorer is active ... + The current file is the file currently opened when an editor is active, + or the selected file in case a Project Explorer is active. \sa currentFile */ @@ -1169,10 +1178,10 @@ void DocumentManager::setCurrentFile(const QString &filePath) } /*! - Returns the absolute path of the current file + Returns the absolute path of the current file. - The current file is e.g. the file currently opened when an editor is active, - or the selected file in case a Project Explorer is active ... + The current file is the file currently opened when an editor is active, + or the selected file in case a Project Explorer is active. \sa setCurrentFile */ @@ -1184,7 +1193,7 @@ QString DocumentManager::currentFile() /*! Returns the initial directory for a new file dialog. If there is - a current file, use that, else use last visited directory. + a current file, uses that, otherwise uses the last visited directory. \sa setFileDialogLastVisitedDirectory */ @@ -1210,7 +1219,7 @@ QString DocumentManager::projectsDirectory() /*! - Set the directory for projects. + Sets the directory for projects. \sa projectsDirectory, useProjectsDirectory */ @@ -1242,8 +1251,8 @@ void DocumentManager::setBuildDirectory(const QString &directory) /*! - Returns whether the directory for projects is to be - used or the user wants the current directory. + Returns whether the directory for projects is to be used or whether the user + chose to use the current directory. \sa setProjectsDirectory, setUseProjectsDirectory */ @@ -1267,7 +1276,7 @@ void DocumentManager::setUseProjectsDirectory(bool useProjectsDirectory) /*! - Returns last visited directory of a file dialog. + Returns the last visited directory of a file dialog. \sa setFileDialogLastVisitedDirectory, fileDialogInitialDirectory @@ -1280,7 +1289,7 @@ QString DocumentManager::fileDialogLastVisitedDirectory() /*! - Set the last visited directory of a file dialog that will be remembered + Sets the last visited directory of a file dialog that will be remembered for the next one. \sa fileDialogLastVisitedDirectory, fileDialogInitialDirectory diff --git a/src/plugins/coreplugin/editormanager/editormanager.cpp b/src/plugins/coreplugin/editormanager/editormanager.cpp index e1a6bc697e..508f2ce8e8 100644 --- a/src/plugins/coreplugin/editormanager/editormanager.cpp +++ b/src/plugins/coreplugin/editormanager/editormanager.cpp @@ -1134,9 +1134,8 @@ bool EditorManager::closeEditors(const QList<IEditor*> &editorsToClose, bool ask emit m_instance->editorsClosed(acceptedEditors.toList()); - foreach (IEditor *editor, acceptedEditors) { - delete editor; - } + foreach (IEditor *editor, acceptedEditors) + editor->deleteLater(); if (currentView && !currentViewHandled) { if (IEditor *editor = currentView->currentEditor()) diff --git a/src/plugins/coreplugin/editormanager/ieditor.cpp b/src/plugins/coreplugin/editormanager/ieditor.cpp index e850e5eb08..f81e23cbd7 100644 --- a/src/plugins/coreplugin/editormanager/ieditor.cpp +++ b/src/plugins/coreplugin/editormanager/ieditor.cpp @@ -35,7 +35,7 @@ different file types. Classes that implement this interface are for example the editors for - C++ files, ui-files and resource files. + C++ files, UI files and resource files. Whenever a user wants to edit or create a file, the EditorManager scans all EditorFactoryInterfaces for suitable editors. The selected EditorFactory @@ -43,12 +43,14 @@ Guidelines for implementing: \list - \li displayName() is used as a user visible description of the document (usually filename w/o path). - \li kind() must be the same value as the kind() of the corresponding EditorFactory. + \li \c displayName() is used as a user visible description of the document + (usually filename w/o path). + \li \c kind() must be the same value as the \c kind() of the corresponding + EditorFactory. \li If duplication is supported, you need to ensure that all duplicates - return the same file(). - \li QString preferredMode() const is the mode the editor manager should activate. - Some editors use a special mode (such as Design mode). + return the same \c file(). + \li QString \c preferredMode() const is the mode the editor manager should + activate. Some editors use a special mode (such as \gui Design mode). \endlist \sa Core::EditorFactoryInterface Core::IContext diff --git a/src/plugins/coreplugin/editormanager/iexternaleditor.cpp b/src/plugins/coreplugin/editormanager/iexternaleditor.cpp index 4a35ba67dd..fa5ae52531 100644 --- a/src/plugins/coreplugin/editormanager/iexternaleditor.cpp +++ b/src/plugins/coreplugin/editormanager/iexternaleditor.cpp @@ -51,6 +51,6 @@ \fn bool IExternalEditor::startEditor(const QString &fileName, QString *errorMessage) = 0; - Opens the editor with \param fileName. Returns true on success or false - on failure along with the error in \param errorMessage. + Opens the editor with \a fileName. Returns \c true on success or \c false + on failure along with the error in \a errorMessage. */ diff --git a/src/plugins/coreplugin/externaltool.cpp b/src/plugins/coreplugin/externaltool.cpp index dcb5b56505..971704272e 100644 --- a/src/plugins/coreplugin/externaltool.cpp +++ b/src/plugins/coreplugin/externaltool.cpp @@ -624,14 +624,13 @@ void ExternalToolRunner::started() void ExternalToolRunner::finished(int exitCode, QProcess::ExitStatus status) { - if (status == QProcess::NormalExit && exitCode == 0) { - if (m_tool->outputHandling() == ExternalTool::ReplaceSelection - || m_tool->errorHandling() == ExternalTool::ReplaceSelection) { - ExternalToolManager::emitReplaceSelectionRequested(m_processOutput); - } - if (m_tool->modifiesCurrentDocument()) - DocumentManager::unexpectFileChange(m_expectedFileName); + if (status == QProcess::NormalExit && exitCode == 0 + && (m_tool->outputHandling() == ExternalTool::ReplaceSelection + || m_tool->errorHandling() == ExternalTool::ReplaceSelection)) { + ExternalToolManager::emitReplaceSelectionRequested(m_processOutput); } + if (m_tool->modifiesCurrentDocument()) + DocumentManager::unexpectFileChange(m_expectedFileName); MessageManager::write( tr("'%1' finished").arg(m_resolvedExecutable), MessageManager::Silent); deleteLater(); diff --git a/src/plugins/coreplugin/featureprovider.cpp b/src/plugins/coreplugin/featureprovider.cpp index ba6510309a..a992e63a67 100644 --- a/src/plugins/coreplugin/featureprovider.cpp +++ b/src/plugins/coreplugin/featureprovider.cpp @@ -39,8 +39,10 @@ The features provided by an object in the object pool implementing IFeatureProvider will be respected by wizards implementing IWizard. - This feature set, provided by all instances of IFeatureProvider in the object pool, is checked against IWizard::requiredFeatures() - and only if all required features are available the wizard is displayed when creating a new file or project. + This feature set, provided by all instances of IFeatureProvider in the + object pool, is checked against \c IWizard::requiredFeatures() + and only if all required features are available, the wizard is displayed + when creating a new file or project. Qt4VersionManager creates an instance of IFeatureProvider and provides Qt specific features for the available versions of Qt. @@ -95,11 +97,11 @@ /*! \fn bool FeatureSet::contains(const Feature &feature) const - \returns true if the \param features is available. + Returns true if \a feature is available. */ /*! \fn bool FeatureSet::contains(const FeatureSet &features) const - \returns true if all \param features are available. + Returns true if all \a features are available. */ diff --git a/src/plugins/coreplugin/generatedfile.cpp b/src/plugins/coreplugin/generatedfile.cpp index c0616efe79..7954c146c4 100644 --- a/src/plugins/coreplugin/generatedfile.cpp +++ b/src/plugins/coreplugin/generatedfile.cpp @@ -42,8 +42,8 @@ namespace Core { \class Core::GeneratedFile \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. + The Wizard 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 diff --git a/src/plugins/coreplugin/icore.cpp b/src/plugins/coreplugin/icore.cpp index 8f57b95117..3e7bb7398f 100644 --- a/src/plugins/coreplugin/icore.cpp +++ b/src/plugins/coreplugin/icore.cpp @@ -37,7 +37,7 @@ /*! \namespace Core \brief The Core namespace contains all classes that make up the Core plugin - which constitute the basic functionality of Qt Creator. + which constitute the basic functionality of \QC. */ /*! @@ -62,11 +62,12 @@ const QList<IWizard *> &wizards, const QString &defaultLocation = QString(), const QVariantMap &extraVariables = QVariantMap()) - \brief Opens a dialog where the user can choose from a set of \a wizards that - create new files/classes/projects. - The \a title argument is shown as the dialogs title. The path where the - files will be created (if the user doesn't change it) is set + 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. @@ -75,8 +76,9 @@ /*! \fn bool ICore::showOptionsDialog(Id group, Id page, QWidget *parent = 0); - \brief Opens the application options/preferences dialog with preselected - \a page in a specified \a group. + + Opens the application \gui Options (or \gui Preferences) dialog with preselected + \a page in the specified \a group. The arguments refer to the string IDs of the corresponding IOptionsPage. */ @@ -88,45 +90,33 @@ Id settingsId = Id(), QWidget *parent = 0) - \brief Show a warning message with a button that opens a settings page. + 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 true if the settings dialog was accepted. + Returns \c true if the settings dialog was accepted. */ /*! - \fn ProgressManager *ICore::progressManager() - \brief Returns the application's progress manager. - - Use the progress manager to register a concurrent task to - show a progress bar the way Qt Creator does it. -*/ + \fn MimeDatabase *ICore::mimeDatabase() -/*! - \fn VcsManager *ICore::vcsManager() - \brief Returns the application's vcs manager. - - The vcs manager can be used to e.g. retrieve information about - the version control system used for a directory on hard disk. - The actual functionality for a specific version control system - must be implemented in a IVersionControl object and registered in - the plugin manager's object pool. + Uses the MIME database to manage MIME types. */ /*! \fn QSettings *ICore::settings(QSettings::Scope scope = QSettings::UserScope) - \brief Returns the application's main settings object. + + 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 QSettings::UserScope (the default), the + 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 Qt Creator. + a fallback to global settings provided with \QC. - If \a scope is QSettings::SystemScope, only the system settings - shipped with the current version of Qt Creator will be read. This + 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() @@ -134,7 +124,8 @@ /*! \fn SettingsDatabase *ICore::settingsDatabase() - \brief Returns the application's settings database. + + 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 @@ -145,7 +136,8 @@ /*! \fn QPrinter *ICore::printer() - \brief Returns the application's printer object. + + Returns the application's printer object. Always use this printer object for printing, so the different parts of the application re-use its settings. @@ -153,33 +145,38 @@ /*! \fn QString ICore::resourcePath() - \brief Returns the absolute path that is used for resources like + + 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 e.g. on Mac the resources are part of the application bundle. + the place, since on Mac OS X, for example, the resources are part of the + application bundle. */ /*! \fn QString ICore::userResourcePath() - \brief Returns the absolute path in the users directory that is used for + + Returns the absolute path in the users directory that is used for resources like project templates. Use this method for finding the place for resources that the user may - write to, e.g. to allow for custom palettes or templates. + write to, for example, to allow for custom palettes or templates. */ /*! \fn QWidget *ICore::mainWindow() - \brief Returns the main application window. - For use as dialog parent etc. + Returns the main application window. + + For use as dialog parent, and so on. */ /*! \fn IContext *ICore::currentContextObject() - \brief Returns the context object of the current main context. + + Returns the context object of the current main context. \sa ICore::updateAdditionalContexts() \sa ICore::addContextObject() @@ -187,7 +184,7 @@ /*! \fn void ICore::updateAdditionalContexts(const Context &remove, const Context &add) - \brief Change the currently active additional contexts. + 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. @@ -197,7 +194,7 @@ /*! \fn bool ICore::hasContext(int context) const - \brief Returns if the given \a context is currently one of the active contexts. + Returns whether the given \a context is currently one of the active contexts. \sa ICore::updateAdditionalContexts() \sa ICore::addContextObject() @@ -205,7 +202,7 @@ /*! \fn void ICore::addContextObject(IContext *context) - \brief Registers an additional \a context object. + Registers an additional \a context object. After registration this context object gets automatically the current context object whenever its widget gets focus. @@ -217,7 +214,7 @@ /*! \fn void ICore::removeContextObject(IContext *context) - \brief Unregisters a \a context object from the list of know contexts. + Unregisters a \a context object from the list of know contexts. \sa ICore::addContextObject() \sa ICore::updateAdditionalContexts() @@ -227,9 +224,9 @@ /*! \fn void ICore::openFiles(const QStringList &fileNames, OpenFilesFlags flags = None) - \brief Open all files from a list of \a fileNames like it would be - done if they were given to Qt Creator on the command line, or - they were opened via \gui{File|Open}. + 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 \gui File > \gui Open. */ /*! @@ -244,12 +241,12 @@ /*! \fn void ICore::coreOpened() - \brief Emitted after all plugins have been loaded and the main window shown. + Indicates that all plugins have been loaded and the main window is shown. */ /*! \fn void ICore::saveSettingsRequested() - \brief Emitted to signal that the user has requested that the global settings + Signals that the user has requested that the global settings should be saved to disk. At the moment that happens when the application is closed, and on \gui{Save All}. @@ -257,29 +254,30 @@ /*! \fn void ICore::optionsDialogRequested() - \brief Signal that allows plugins to perform actions just before the \gui{Tools|Options} + Enables plugins to perform actions just before the \gui Tools > \gui Options dialog is shown. */ /*! \fn void ICore::coreAboutToClose() - \brief Plugins can do some pre-end-of-life actions when they get this signal. + Enables plugins to perform some pre-end-of-life actions. The application is guaranteed to shut down after this signal is emitted. - It's there as an addition to the usual plugin lifecycle methods, namely - IPlugin::aboutToShutdown(), just for convenience. + It is there as an addition to the usual plugin lifecycle methods, namely + \c IPlugin::aboutToShutdown(), just for convenience. */ /*! \fn void ICore::contextAboutToChange(const QList<Core::IContext *> &context) - \brief Sent just before a new \a context becomes the current context - (meaning that itself or one of its child widgets got focus). + Indicates that a new \a context will shortly become the current context + (meaning that its widget got focus). */ /*! \fn void ICore::contextChanged(Core::IContext *context, const Core::Context &additionalContexts) - \brief Sent just after a new \a context became the current context - (meaning that its widget got focus), or if the additional context ids changed. + Indicates that a new \a context just became the current context + (meaning that its widget got focus), or that the additional context ids + specified by \a additionalContexts changed. */ #include "mainwindow.h" diff --git a/src/plugins/coreplugin/icorelistener.cpp b/src/plugins/coreplugin/icorelistener.cpp new file mode 100644 index 0000000000..08ee9895e2 --- /dev/null +++ b/src/plugins/coreplugin/icorelistener.cpp @@ -0,0 +1,58 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of Qt Creator. +** +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Digia gives you certain additional +** rights. These rights are described in the Digia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +****************************************************************************/ + +#include "icorelistener.h" + +/*! + \class Core::ICoreListener + + \brief The ICoreListener class provides a hook for plugins to veto on + certain events emitted from the core plugin. + + Implement this interface to prevent certain events from occurring. For + example, to prevent the closing of the whole application + or to prevent the closing of an editor window under certain conditions. + + For example, if the application window requests a close, + \c ICoreListener::coreAboutToClose() is called (in arbitrary order) on all + registered objects implementing this interface. If one if these calls + returns \c false, the process is aborted and the event is ignored. If all + calls return \c true, the corresponding signal is emitted and the event is + accepted or performed. + + Guidelines for implementing the class: + \list + \li Return \c false from the implemented method if you want to prevent + the event. + \li Add your implementing object to the plugin managers objects: + \c{ExtensionSystem::PluginManager::instance()->addObject(yourImplementingObject)} + \li Do not forget to remove the object again at deconstruction + (for example, in the destructor of your plugin). + \endlist +*/ diff --git a/src/plugins/coreplugin/icorelistener.h b/src/plugins/coreplugin/icorelistener.h index 9d29802dc6..7fb0061e2e 100644 --- a/src/plugins/coreplugin/icorelistener.h +++ b/src/plugins/coreplugin/icorelistener.h @@ -35,30 +35,7 @@ namespace Core { class IEditor; -/*! - \class Core::ICoreListener - \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 - or to prevent the closing of an editor window under certain conditions. - - If e.g. the application window requests a close, then first - ICoreListener::coreAboutToClose() is called (in arbitrary order) on all - registered objects implementing this interface. If one if these calls returns - false, the process is aborted and the event is ignored. If all calls return - true, the corresponding signal is emitted and the event is accepted/performed. - - Guidelines for implementing: - \list - \li Return false from the implemented method if you want to prevent the event. - \li You need to add your implementing object to the plugin managers objects: - ExtensionSystem::PluginManager::instance()->addObject(yourImplementingObject); - \li Don't forget to remove the object again at deconstruction (e.g. in the destructor of - your plugin). -*/ class CORE_EXPORT ICoreListener : public QObject { Q_OBJECT diff --git a/src/plugins/coreplugin/id.cpp b/src/plugins/coreplugin/id.cpp index f3bd5d4c5d..3bc21c5c97 100644 --- a/src/plugins/coreplugin/id.cpp +++ b/src/plugins/coreplugin/id.cpp @@ -54,7 +54,7 @@ namespace Core { and associated with a plain 7-bit-clean ASCII name used for display and persistency. - Each plugin that is distributed as part of Qt Creator has a + Each plugin that is distributed as part of \QC has a private range of 10000 UIDs that are guaranteed to be unique. Third party plugins are advised to construct ids from their @@ -137,10 +137,10 @@ static int theId(const QByteArray &ba) /*! \fn Core::Id::Id(int uid) - \brief Constructs an id given a UID. + Constructs an id given \a UID. The UID is an integer value that is unique within the running - Qt Creator process. + \QC process. It is the callers responsibility to ensure the uniqueness of the passed integer. The recommended approach is to use @@ -152,9 +152,9 @@ static int theId(const QByteArray &ba) */ /*! - Constructs an id given its associated name. The internal + Constructs an id given its associated \a name. The internal representation will be unspecified, but consistent within a - Qt Creator process. + \QC process. */ Id::Id(const char *name) @@ -248,7 +248,7 @@ Id Id::fromSetting(const QVariant &variant) This can be used to construct groups of ids logically belonging together. The associated internal name - will be generated by appending \c{suffix}. + will be generated by appending \a suffix. */ Id Id::withSuffix(int suffix) const @@ -284,7 +284,7 @@ Id Id::withSuffix(const QString &suffix) const This can be used to construct groups of ids logically belonging together. The associated internal name - will be generated by prepending \c{prefix}. + will be generated by prepending \a prefix. */ Id Id::withPrefix(const char *prefix) const @@ -332,9 +332,9 @@ bool Id::alphabeticallyBefore(Id other) const /*! - Convenience function to extract a part of the id string - representation. This can be used to split off the base - part used when generating an id with \c{withSuffix()}. + Extracts a part of the id string + representation. This function can be used to split off the base + part specified by \a baseId used when generating an id with \c{withSuffix()}. \sa withSuffix() */ diff --git a/src/plugins/coreplugin/mimedatabase.cpp b/src/plugins/coreplugin/mimedatabase.cpp index 7641ed75f7..142c270bb8 100644 --- a/src/plugins/coreplugin/mimedatabase.cpp +++ b/src/plugins/coreplugin/mimedatabase.cpp @@ -113,8 +113,8 @@ namespace Internal { \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). + This class exists to enable reading the file contents \e {on demand}, + as opposed to each mime type trying to open and read while checking. \sa Core::MimeType, Core::MimeDatabase, Core::IMagicMatcher, Core::MagicRuleMatcher, Core::MagicRule, Core::MagicStringRule, Core::MagicByteRule, Core::GlobPattern \sa Core::Internal::BinaryMatcher, Core::Internal::HeuristicTextMagicMatcher @@ -196,8 +196,8 @@ public: \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. + If the data does not contain any character below tab (9), it is detected as + text. Additionally, UTF16 byte order markers are checked. \sa Core::MimeType, Core::MimeDatabase, Core::IMagicMatcher, Core::MagicRuleMatcher, Core::MagicRule, Core::MagicStringRule, Core::MagicByteRule, Core::GlobPattern \sa Core::Internal::FileMatchContext, Core::Internal::BinaryMatcher @@ -244,8 +244,8 @@ bool HeuristicTextMagicMatcher::matches(const QByteArray &data) const and offset specification. Stores the offset and provides conversion helpers. - Base class for implementations for "string" and "byte". - (Others like little16, big16, etc. can be created whenever there is a need.) + Base class for implementations for \c string and \c byte. + Others, such as \c little16 and \c big16, can be created when needed. \sa Core::MimeType, Core::MimeDatabase, Core::IMagicMatcher, Core::MagicRuleMatcher, Core::MagicStringRule, Core::MagicByteRule, Core::GlobPattern \sa Core::Internal::FileMatchContext, Core::Internal::BinaryMatcher, Core::Internal::HeuristicTextMagicMatcher @@ -419,7 +419,7 @@ bool MagicByteRule::matches(const QByteArray &data) const \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. + This class is used for rules parsed from XML files. \sa Core::MimeType, Core::MimeDatabase, Core::IMagicMatcher, Core::MagicRule, Core::MagicStringRule, Core::MagicByteRule, Core::GlobPattern \sa Core::Internal::FileMatchContext, Core::Internal::BinaryMatcher, Core::Internal::HeuristicTextMagicMatcher @@ -528,17 +528,17 @@ bool MimeGlobPattern::matches(const QString &fileName) const \brief The MimeType class contains MIME type data used in \QC. - Contains most information from standard mime type XML database files. + Contains most information from standard MIME type XML database files. - Currently, magic of types "string", "bytes" is supported. In addition, - C++ classes, derived from Core::IMagicMatcher can be added to check + Currently, magic of types \c string anc \c bytes is supported. In addition, + C++ classes, derived from \c Core::IMagicMatcher can be added to check on contents. - In addition, the class provides a list of suffixes and a concept of the - 'preferred suffix' (derived from glob patterns). This is used for example - to be able to configure the suffix used for C++-files in Qt Creator. + The class provides a list of suffixes and a concept of a + \e {preferred suffix} (derived from glob patterns). This is used for example + to be able to configure the suffix used for C++ files in \QC. - Mime XML looks like: + MIME type XML files look like follows: \code <?xml version="1.0" encoding="UTF-8"?> <mime-info xmlns="http://www.freedesktop.org/standards/shared-mime-info"> @@ -929,7 +929,8 @@ namespace Internal { \brief The BaseMimeTypeParser class provides a generic parser for a sequence of <mime-type>. - Calls abstract handler function process for MimeType it finds. + This class calls the abstract handler function process for the MIME types + it finds. \sa Core::MimeDatabase, Core::IMagicMatcher, Core::MagicRuleMatcher, Core::MagicRule, Core::MagicStringRule, Core::MagicByteRule, Core::GlobPattern \sa Core::Internal::FileMatchContext, Core::Internal::BinaryMatcher, Core::Internal::HeuristicTextMagicMatcher @@ -1197,37 +1198,38 @@ MimeMapEntry::MimeMapEntry(const MimeType &t, int aLevel) : The class is protected by a QMutex and can therefore be accessed by threads. - A good testcase is to run it over \c '/usr/share/mime/<*>/<*>.xml' on Linux. + A good testcase is to run it over \c {/usr/share/mime/<*>/<*>.xml} on Linux. - When adding a "text/plain" to it, the mimetype will receive a magic matcher + When adding a \c{text/plain} to it, the MIME type will receive a magic matcher that checks for text files that do not match the globs by heuristics. \section1 Design Considerations Storage requirements: \list - \li Must be robust in case of incomplete hierarchies, dangling entries - \li Plugins will not load and register their mime types in order of inheritance. - \li Multiple inheritance (several subClassesOf) can occur - \li Provide quick lookup by name + \li Must be robust in case of incomplete hierarchies and dangling entries. + \li Plugins will not load and register their MIME types in order of + inheritance. + \li Multiple inheritance (several subClassesOf) can occur. + \li Provide quick lookup by name. \li Provide quick lookup by file type. \endlist - This basically rules out some pointer-based tree, so the structure chosen is: + This basically rules out a pointer-based tree, so the structure chosen is: \list - \li An alias map QString->QString for mapping aliases to types - \li A Map QString->MimeMapEntry for the types (MimeMapEntry being a pair of + \li An alias map \c {QString->QString} for mapping aliases to types. + \li A map \c {QString->MimeMapEntry} for the types (MimeMapEntry being a pair of MimeType and (hierarchy) level. - \li A map QString->QString representing parent->child relations (enabling - recursing over children) + \li A map \c {QString->QString} representing parent to child relations (enabling + recursing over children). \li Using strings avoids dangling pointers. \endlist - The hierarchy level is used for mapping by file types. When findByFile() - is first called after addMimeType() it recurses over the hierarchy and sets + The hierarchy level is used for mapping by file types. When \c findByFile() + is first called after \c addMimeType(), it recurses over the hierarchy and sets the hierarchy level of the entries accordingly (0 toplevel, 1 first order...). It then does several passes over the type map, checking the - globs for maxLevel, maxLevel-1....until it finds a match (idea being to + globs for maxLevel, maxLevel-1....until it finds a match (the idea being to check the most specific types first). Starting a recursion from the leaves is not suitable since it will hit parent nodes several times. diff --git a/src/plugins/coreplugin/textdocument.cpp b/src/plugins/coreplugin/textdocument.cpp index e210cbb6a2..17257e08cb 100644 --- a/src/plugins/coreplugin/textdocument.cpp +++ b/src/plugins/coreplugin/textdocument.cpp @@ -38,7 +38,7 @@ \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 + This class stores the format obtained from read operations and uses that when writing out files, thus ensuring that CRLF/encodings are preserved. \sa Utils::TextFileUtils @@ -83,7 +83,7 @@ QByteArray TextDocument::decodingErrorSample() const } /*! - \brief Writes out text using the format obtained from the last read. + Writes out text using the format obtained from the last read. */ bool TextDocument::write(const QString &fileName, const QString &data, QString *errorMessage) const @@ -92,7 +92,7 @@ bool TextDocument::write(const QString &fileName, const QString &data, QString * } /*! - \brief Writes out text using a custom format obtained. + Writes out text using a custom \a format. */ bool TextDocument::write(const QString &fileName, const Utils::TextFileFormat &format, const QString &data, QString *errorMessage) const @@ -103,7 +103,7 @@ bool TextDocument::write(const QString &fileName, const Utils::TextFileFormat &f } /*! - \brief Autodetect format and read in a text file. + Autodetects format and reads in the text file specified by \a fileName. */ TextDocument::ReadResult TextDocument::read(const QString &fileName, QStringList *plainTextList, QString *errorString) @@ -115,7 +115,7 @@ TextDocument::ReadResult TextDocument::read(const QString &fileName, QStringList } /*! - \brief Autodetect format and read in a text file. + Autodetects format and reads in the text file specified by \a fileName. */ TextDocument::ReadResult TextDocument::read(const QString &fileName, QString *plainText, QString *errorString) @@ -146,7 +146,7 @@ void TextDocument::switchUtf8Bom() } /*! - \brief Returns the format obtained from the last call to read(). + Returns the format obtained from the last call to \c read(). */ Utils::TextFileFormat TextDocument::format() const diff --git a/src/plugins/cpptools/cpppointerdeclarationformatter.cpp b/src/plugins/cpptools/cpppointerdeclarationformatter.cpp index 6040bae7f7..53480f9b70 100644 --- a/src/plugins/cpptools/cpppointerdeclarationformatter.cpp +++ b/src/plugins/cpptools/cpppointerdeclarationformatter.cpp @@ -51,7 +51,7 @@ using namespace CppTools; /*! - \brief Skip not type relevant specifiers and return the index of the + Skips specifiers that are not type relevant and returns the index of the first specifier token which is not followed by __attribute__ ((T___ATTRIBUTE__)). @@ -60,17 +60,20 @@ using namespace CppTools; Consider these cases: - static char *s = 0; - typedef char *s cp; - __attribute__((visibility("default"))) char *f(); + \list + \li \c {static char *s = 0;} + \li \c {typedef char *s cp;} + \li \c {__attribute__((visibility("default"))) char *f();} + \endlist - For all cases we want to skip all the not type relevant specifer + For all these cases we want to skip all the specifiers that are not type + relevant (since these are not part of the type and thus are not rewritten). - \param list The specifier list to iterate - \param translationUnit The TranslationUnit - \param endToken Do not check further than this token - \param found Output parameter, must not be 0. + \a list is the specifier list to iterate and \a translationUnit is the + translation unit. + \a endToken is the last token to check. + \a found is an output parameter that must not be 0. */ static unsigned firstTypeSpecifierWithoutFollowingAttribute( SpecifierListAST *list, TranslationUnit *translationUnit, unsigned endToken, bool *found) @@ -363,11 +366,8 @@ void PointerDeclarationFormatter::processIfWhileForStatement(ExpressionAST *expr } /*! - \brief Do some further checks and rewrite the symbol's type and - name into the given range - - \param symbol the symbol to be rewritten - \param range the substitution range in the file + Performs some further checks and rewrites the type and name of \a symbol + into the substitution range in the file specified by \a tokenRange. */ void PointerDeclarationFormatter::checkAndRewrite(DeclaratorAST *declarator, Symbol *symbol, diff --git a/src/plugins/cpptools/cpppointerdeclarationformatter.h b/src/plugins/cpptools/cpppointerdeclarationformatter.h index 621c6d3971..9eadd6ed26 100644 --- a/src/plugins/cpptools/cpppointerdeclarationformatter.h +++ b/src/plugins/cpptools/cpppointerdeclarationformatter.h @@ -63,10 +63,10 @@ public: /*! \enum PointerDeclarationFormatter::CursorHandling - This simplifies the QuickFix implementation. + This enum type simplifies the QuickFix implementation. \value RespectCursor - Consider the cursor position / selection of the CppRefactoringFile + Consider the cursor position or selection of the CppRefactoringFile for rejecting edit operation candidates for the resulting ChangeSet. If there is a selection, the range of the edit operation candidate should be inside the selection. If there is no selection, the cursor diff --git a/src/plugins/debugger/cdb/cdbparsehelpers.cpp b/src/plugins/debugger/cdb/cdbparsehelpers.cpp index 4705e22e28..fe7a28166a 100644 --- a/src/plugins/debugger/cdb/cdbparsehelpers.cpp +++ b/src/plugins/debugger/cdb/cdbparsehelpers.cpp @@ -425,7 +425,7 @@ QDebug operator<<(QDebug s, const WinException &e) /*! \fn DisassemblerLines Debugger::Internal::parseCdbDisassembler(const QList<QByteArray> &a) - \brief Parse CDB disassembler output into DisassemblerLines (with helpers) + Parses CDB disassembler output into DisassemblerLines (with helpers). Expected options (prepend source file line): \code diff --git a/src/plugins/debugger/debuggerplugin.cpp b/src/plugins/debugger/debuggerplugin.cpp index 28b0859c32..6e4606e884 100644 --- a/src/plugins/debugger/debuggerplugin.cpp +++ b/src/plugins/debugger/debuggerplugin.cpp @@ -159,7 +159,7 @@ \brief The DebuggerEngine class is the base class of a debugger engine. - Note: the Debugger process itself and any helper processes like + \note The Debugger process itself and any helper processes like gdbserver are referred to as 'Engine', whereas the debugged process is referred to as 'Inferior'. @@ -330,9 +330,11 @@ sg1: } GdbEngine specific startup. All happens in EngineSetupRequested state: - Transitions marked by '---' are done in the individual adapters. + \list + \li Transitions marked by '---' are done in the individual adapters. - Transitions marked by '+-+' are done in the GdbEngine. + \li Transitions marked by '+-+' are done in the GdbEngine. + \endlist \code GdbEngine::setupEngine() diff --git a/src/plugins/debugger/debuggersourcepathmappingwidget.cpp b/src/plugins/debugger/debuggersourcepathmappingwidget.cpp index 5896140b36..60854617f0 100644 --- a/src/plugins/debugger/debuggersourcepathmappingwidget.cpp +++ b/src/plugins/debugger/debuggersourcepathmappingwidget.cpp @@ -193,7 +193,7 @@ void SourcePathMappingModel::setTarget(int row, const QString &t) \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. + Path mappings to be applied using source path substitution in GDB. */ DebuggerSourcePathMappingWidget::DebuggerSourcePathMappingWidget(QWidget *parent) : diff --git a/src/plugins/debugger/debuggertooltipmanager.cpp b/src/plugins/debugger/debuggertooltipmanager.cpp index fe2767e919..f61ceffe9e 100644 --- a/src/plugins/debugger/debuggertooltipmanager.cpp +++ b/src/plugins/debugger/debuggertooltipmanager.cpp @@ -559,7 +559,7 @@ QDebug operator<<(QDebug d, const DebuggerToolTipContext &c) (defaultModel) and displays that. It is associated with file name and position with functionality to - acquire and release the engine: When the debugger stops at a file, all + acquire and release the engine. When the debugger stops at a file, all matching tooltips acquire the engine, that is, display the engine data. When continuing or switching away from the frame, the tooltips release the engine, that is, store the data internally and keep displaying them @@ -1078,11 +1078,11 @@ QString DebuggerToolTipWidget::clipboardContents() const 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 - for the current editor (by file name), position and show them. + Listens to editor change and mode change. In debug mode, if there are tooltips + for the current editor (by file name), positions and shows them. In addition, listens on state change and stack frame completed signals - of the engine. If a stack frame is completed, have all matching tooltips + of the engine. If a stack frame is completed, has all matching tooltips (by file name and function) acquire the engine, others release. */ diff --git a/src/plugins/debugger/gdb/gdbengine.cpp b/src/plugins/debugger/gdb/gdbengine.cpp index ca5cfe27ea..b2cab00f27 100644 --- a/src/plugins/debugger/gdb/gdbengine.cpp +++ b/src/plugins/debugger/gdb/gdbengine.cpp @@ -2416,9 +2416,9 @@ void GdbEngine::handleExecuteReturn(const GdbResponse &response) } /*! - \brief Discard the results of all pending watch-updating commands. + Discards the results of all pending watch-updating commands. - This method is called at the beginning of all step/next/finish etc. + This method is called at the beginning of all step, next, finish, and so on, debugger functions. If non-watch-updating commands with call-backs are still in the pipe, it will complain. diff --git a/src/plugins/debugger/memoryview.cpp b/src/plugins/debugger/memoryview.cpp index 38d10d44d4..3fdb256b37 100644 --- a/src/plugins/debugger/memoryview.cpp +++ b/src/plugins/debugger/memoryview.cpp @@ -43,7 +43,7 @@ namespace Internal { \class Debugger::Internal::MemoryView \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 + This class is a small tool-window that stays on top and displays a chunk of memory based on the widget provided by the Bin editor plugin. Provides static functionality for handling a Bin Editor Widget diff --git a/src/plugins/debugger/watchwindow.cpp b/src/plugins/debugger/watchwindow.cpp index 99a86b2757..81e4798578 100644 --- a/src/plugins/debugger/watchwindow.cpp +++ b/src/plugins/debugger/watchwindow.cpp @@ -237,7 +237,7 @@ static int memberVariableRecursion(const QAbstractItemModel *model, typedef QList<MemoryMarkup> MemoryMarkupList; /*! - \brief Creates markup for a variable in the memory view. + Creates markup for a variable in the memory view. Marks the visible children with alternating colors in the parent, that is, for \code diff --git a/src/plugins/fakevim/fakevimhandler.cpp b/src/plugins/fakevim/fakevimhandler.cpp index 9c800a8958..50dd3421c9 100644 --- a/src/plugins/fakevim/fakevimhandler.cpp +++ b/src/plugins/fakevim/fakevimhandler.cpp @@ -2127,7 +2127,7 @@ void FakeVimHandler::Private::focus() void FakeVimHandler::Private::enterFakeVim() { - QTC_ASSERT(!g.inFakeVim, qDebug() << "enterFakeVim() shouldn't be called recursively!"); + QTC_ASSERT(!g.inFakeVim, qDebug() << "enterFakeVim() shouldn't be called recursively!"; return); m_cursor = EDITOR(textCursor()); g.inFakeVim = true; @@ -2151,7 +2151,7 @@ void FakeVimHandler::Private::enterFakeVim() void FakeVimHandler::Private::leaveFakeVim(bool needUpdate) { - QTC_ASSERT(g.inFakeVim, qDebug() << "enterFakeVim() not called before leaveFakeVim()!"); + QTC_ASSERT(g.inFakeVim, qDebug() << "enterFakeVim() not called before leaveFakeVim()!"; return); // The command might have destroyed the editor. if (m_textedit || m_plaintextedit) { diff --git a/src/plugins/find/ifindfilter.cpp b/src/plugins/find/ifindfilter.cpp index 65c2877656..06754f9ca0 100644 --- a/src/plugins/find/ifindfilter.cpp +++ b/src/plugins/find/ifindfilter.cpp @@ -35,15 +35,15 @@ /*! \class Find::IFindFilter \brief The IFindFilter class is the base class for find implementations - that are invoked via the \gui{Edit -> Find/Replace -> Advanced Find} - dialog. + that are invoked by selecting \gui Edit > \gui {Find/Replace} > + \gui {Advanced Find}. - Implementations of this class add an additional "Scope" to the Advanced - Find dialog. That can be any search that requires the user to provide + Implementations of this class add an additional \gui Scope to the \gui {Advanced + Find} dialog. That can be any search that requires the user to provide a text based search term (potentially with find flags like searching case sensitively or using regular expressions). Existing - scopes are e.g. "All Projects" (i.e. search in all files in all projects) - and "Files on File System" where the user provides a directory and file + scopes are \gui {All Projects} that searches from all files in all projects + and \gui {Files on File System} where the user provides a directory and file patterns to search. To make your find scope available to the user, you need to implement this @@ -57,8 +57,7 @@ the details for this kind of search, only requiring you to provide an iterator over the file names of the files that should be searched. - If you want to implement a more specialized find filter, you'll need - to + If you want to implement a more specialized find filter, you need to: \list \li Start your search in a separate thread \li Make this known to the Core::ProgressManager, for a progress bar @@ -75,7 +74,7 @@ The common pattern is roughly this: - Implement the actual search within a QtConcurrent based method, i.e. + Implement the actual search within a QtConcurrent based method, that is a method that takes a \c{QFutureInterface<MySearchResult> &future} as the first parameter and the other information needed for the search as additional parameters. It should set useful progress information @@ -101,25 +100,26 @@ /*! \fn QString IFindFilter::id() const - \brief Unique string identifier for this find filter. + Returns the unique string identifier for this find filter. Usually should be something like "MyPlugin.MyFindFilter". */ /*! \fn QString IFindFilter::displayName() const - \brief The name of the find filter/scope as presented to the user. + Returns the name of the find filter or scope as presented to the user. - This is the name that e.g. appears in the scope selection combo box. - Always return a translatable string (i.e. use tr() for the return value). + This is the name that appears in the scope selection combo box, for example. + Always return a translatable string (that is, use tr() for the return value). */ /*! \fn bool IFindFilter::isEnabled() const - \brief Returns if the user should be able to select this find filter + Returns whether the user should be able to select this find filter at the moment. - This is used e.g. for the "Current Projects" scope - if the user hasn't + This is used for the \gui {Current Projects} scope, for example. If the user + has not opened a project, the scope is disabled. \sa changed() @@ -127,8 +127,8 @@ /*! \fn QKeySequence IFindFilter::defaultShortcut() const - \brief Returns the shortcut that can be used to open the advanced find - dialog with this filter/scope preselected. + Returns the shortcut that can be used to open the advanced find + dialog with this filter or scope preselected. Usually return an empty shortcut here, the user can still choose and assign a specific shortcut to this find scope via the preferences. @@ -136,22 +136,22 @@ /*! \fn bool IFindFilter::isReplaceSupported() const - \brief Returns if the find filter supports search and replace. + Returns whether the find filter supports search and replace. - The default value is false, override this method to return true, if + The default value is false, override this method to return \c true, if your find filter supports global search and replace. */ /*! \fn void IFindFilter::findAll(const QString &txt, Find::FindFlags findFlags) - \brief This method is called when the user selected this find scope and + This method is called when the user selected this find scope and initiated a search. You should start a thread which actually performs the search for \a txt using the given \a findFlags (add it to Core::ProgressManager for a progress bar!) and presents the search results to the user (using the \gui{Search Results} output pane). - For more information see the descriptions of this class, + For more information, see the descriptions of this class, Core::ProgressManager, and Find::SearchResultWindow. \sa replaceAll() @@ -161,7 +161,7 @@ /*! \fn void IFindFilter::replaceAll(const QString &txt, Find::FindFlags findFlags) - \brief Override this method if you want to support search and replace. + Override this method if you want to support search and replace. This method is called when the user selected this find scope and initiated a search and replace. @@ -181,33 +181,34 @@ /*! \fn QWidget *IFindFilter::createConfigWidget() - \brief Return a widget that contains additional controls for options + Returns a widget that contains additional controls for options for this find filter. - The widget will be shown below the common options in the Advanced Find + The widget will be shown below the common options in the \gui {Advanced Find} dialog. It will be reparented and deleted by the find plugin. */ /*! \fn void IFindFilter::writeSettings(QSettings *settings) - \brief Called at shutdown to write the state of the additional options + Called at shutdown to write the state of the additional options for this find filter to the \a settings. */ /*! \fn void IFindFilter::readSettings(QSettings *settings) - \brief Called at startup to read the state of the additional options + Called at startup to read the state of the additional options for this find filter from the \a settings. */ /*! \fn void IFindFilter::enabledChanged(bool enabled) - \brief Signals that the enabled state of this find filter has changed. + + Signals that the enabled state of this find filter has changed. */ /*! \fn Find::FindFlags BaseTextFind::supportedFindFlags() const - \brief Returns the find flags, like whole words or regular expressions, + Returns the find flags, like whole words or regular expressions, that this find filter supports. Depending on the returned value, the default find option widgets are diff --git a/src/plugins/find/searchresultwindow.cpp b/src/plugins/find/searchresultwindow.cpp index 12b1181e6a..38b2e58224 100644 --- a/src/plugins/find/searchresultwindow.cpp +++ b/src/plugins/find/searchresultwindow.cpp @@ -191,10 +191,10 @@ using namespace Find::Internal; /*! \enum Find::SearchResultWindow::SearchMode - Specifies if a search should show the replace UI or not. + This enum type specifies whether a search should show the replace UI or not: \value SearchOnly - The search doesn't support replace. + The search does not support replace. \value SearchAndReplace The search supports replace, so show the UI for it. */ @@ -211,14 +211,14 @@ using namespace Find::Internal; /*! \fn void SearchResult::activated(const Find::SearchResultItem &item) - \brief Sent if the user activated (e.g. double-clicked) a search result - \a item. + Indicates that the user activated the search result \a item by + double-clicking it, for example. */ /*! \fn void SearchResult::replaceButtonClicked(const QString &replaceText, const QList<Find::SearchResultItem> &checkedItems, bool preserveCase) - \brief Sent when the user initiated a replace, e.g. by pressing the replace - all button. + Indicates that the user initiated a text replace by selecting + \gui {Replace All}, for example. The signal reports the text to use for replacement in \a replaceText, and the list of search result items that were selected by the user @@ -243,14 +243,14 @@ using namespace Find::Internal; selecting an entry and performing a global replace. Whenever you start a search, call startNewSearch(SearchMode) to initialize - the search result window. The parameter determines if the GUI for + the \gui {Search Results} output pane. The parameter determines if the GUI for replacing should be shown. The method returns a SearchResult object that is your hook into the signals from user interaction for this search. When you produce search results, call addResults or addResult to add them - to the search result window. - After the search has finished call finishSearch to inform the search - result window about it. + to the \gui {Search Results} output pane. + After the search has finished call finishSearch to inform the + \gui {Search Results} output pane about it. You will get activated signals via your SearchResult instance when the user selects a search result item, and, if you started the search @@ -317,7 +317,7 @@ SearchResultWindow::~SearchResultWindow() } /*! - \brief Returns the single shared instance of the Search Results window. + Returns the single shared instance of the \gui {Search Results} output pane. */ SearchResultWindow *SearchResultWindow::instance() { @@ -350,12 +350,12 @@ QList<QWidget*> SearchResultWindow::toolBarWidgets() const } /*! - \brief Tells the search results window to start a new search. + Tells the \gui {Search Results} output pane to start a new search. - The \a label should be a string that shortly describes the type of - search, i.e. search filter and possibly a most relevant search option, followed by a colon ':'. - E.g. \code{Project 'myproject':} - The \a searchTerm will be shown behind the colon. + The \a label should be a string that shortly describes the type of the + search, that is, the search filter and possibly the most relevant search + option, followed by a colon ':'. For example: \c {Project 'myproject':} + The \a searchTerm is shown after the colon. The \a toolTip should elaborate on the search parameters, like file patterns that are searched and find flags. If \a cfgGroup is not empty, it will be used for storing the "do not ask again" @@ -365,7 +365,8 @@ QList<QWidget*> SearchResultWindow::toolBarWidgets() const with the results of this search. The search result window owns the returned SearchResult and might delete it any time, even while the search is running - (e.g. when the user clears the search result pane, or if the user opens so many other searches + (for example, when the user clears the \gui {Search Results} pane, or when + the user opens so many other searches that this search falls out of the history). */ @@ -408,7 +409,7 @@ SearchResult *SearchResultWindow::startNewSearch(const QString &label, } /*! - \brief Clears the current contents in the search result window. + Clears the current contents of the \gui {Search Results} output pane. */ void SearchResultWindow::clearContents() { @@ -600,7 +601,7 @@ SearchResult::SearchResult(SearchResultWidget *widget) } /*! - \brief Attach some random \a data to this search, that you can use later. + Attaches some random \a data to this search, that you can use later. \sa userData() */ @@ -610,7 +611,8 @@ void SearchResult::setUserData(const QVariant &data) } /*! - \brief Return the data that was attached to this search by calling setUserData(). + Returns the data that was attached to this search by calling + setUserData(). \sa setUserData() */ @@ -620,7 +622,7 @@ QVariant SearchResult::userData() const } /*! - \brief Returns the text that should replace the text in search results. + Returns the text that should replace the text in search results. */ QString SearchResult::textToReplace() const { @@ -638,13 +640,14 @@ void SearchResult::setSearchAgainSupported(bool supported) } /*! - \brief Adds a single result line to the search results. + Adds a single result line to the \gui {Search Results} output pane. - The \a fileName, \a lineNumber and \a rowText are shown in the result line. + \a fileName, \a lineNumber, and \a lineText are shown on the result line. \a searchTermStart and \a searchTermLength specify the region that - should be visually marked (string position and length in \a rowText). + should be visually marked (string position and length in \a lineText). You can attach arbitrary \a userData to the search result, which can - be used e.g. when reacting to the signals of the SearchResult for your search. + be used, for example, when reacting to the signals of the search results + for your search. \sa addResults() */ @@ -657,8 +660,7 @@ void SearchResult::addResult(const QString &fileName, int lineNumber, const QStr } /*! - \brief Adds all of the given search result \a items to the search - results window. + Adds the search result \a items to the \gui {Search Results} output pane. \sa addResult() */ @@ -669,7 +671,7 @@ void SearchResult::addResults(const QList<SearchResultItem> &items, AddMode mode } /*! - \brief Notifies the search result window that the current search + Notifies the \gui {Search Results} output pane that the current search has finished, and the UI should reflect that. */ void SearchResult::finishSearch(bool canceled) @@ -678,7 +680,7 @@ void SearchResult::finishSearch(bool canceled) } /*! - \brief Sets the value in the UI element that allows the user to type + Sets the value in the UI element that allows the user to type the text that should replace text in search results to \a textToReplace. */ void SearchResult::setTextToReplace(const QString &textToReplace) @@ -687,7 +689,7 @@ void SearchResult::setTextToReplace(const QString &textToReplace) } /*! - * \brief Removes all search results. + * Removes all search results. */ void SearchResult::restart() { @@ -700,7 +702,7 @@ void SearchResult::setSearchAgainEnabled(bool enabled) } /*! - * \brief Pops up the search result panel with this search. + * Opens the \gui {Search Results} output pane with this search. */ void SearchResult::popup() { diff --git a/src/plugins/genericprojectmanager/genericproject.cpp b/src/plugins/genericprojectmanager/genericproject.cpp index 6dc882b787..69c5209063 100644 --- a/src/plugins/genericprojectmanager/genericproject.cpp +++ b/src/plugins/genericprojectmanager/genericproject.cpp @@ -420,7 +420,6 @@ bool GenericProject::fromMap(const QVariantMap &map) foreach (Target *t, targetList) { if (!t->activeBuildConfiguration()) { removeTarget(t); - delete t; continue; } if (!t->activeRunConfiguration()) diff --git a/src/plugins/macros/imacrohandler.cpp b/src/plugins/macros/imacrohandler.cpp index b6a145c375..25630a24ae 100644 --- a/src/plugins/macros/imacrohandler.cpp +++ b/src/plugins/macros/imacrohandler.cpp @@ -38,35 +38,36 @@ using namespace Macros::Internal; \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 + They are used to create and replay macro events. Use + MacroManager::registerEventHandler to add a new event handler. */ /*! \fn void IEventHandler::startRecording(Macro* macro) - This method is called when starting to record a macro, it can be used - to initialize some data. + Initializes some data when starting to record a macro. */ /*! \fn void IEventHandler::endRecordingMacro(Macro* macro) - This method is called after recording a macro, to cleanup everything. + Cleans up after recording a macro. */ /*! \fn bool IEventHandler::canExecuteEvent(const MacroEvent ¯oEvent) - When replaying a macro, the manager iterate through all macro events - in the macro and call this method to know which handler to use. - If the method returns true, executeEvent is called. + When replaying a macro, the manager iterates through all macro events + specified in \a macroEvent + in the macro and calls this method to determine which handler to use. + If the method returns \c true, \c executeEvent is called. */ /*! \fn bool IEventHandler::executeEvent(const MacroEvent ¯oEvent) - This method execute a specific macro event, using the values stored in + Executes the specified \a macroEvent, using the values stored in the macro event. */ diff --git a/src/plugins/macros/macro.cpp b/src/plugins/macros/macro.cpp index e14907625b..4f7e174626 100644 --- a/src/plugins/macros/macro.cpp +++ b/src/plugins/macros/macro.cpp @@ -44,8 +44,8 @@ using namespace Macros::Internal; \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 + A macro is a list of events that can be replayed in \QC. A macro has + an header consisting of the \QC version where the macro was created and a description. The name of the macro is the filename without the extension. */ diff --git a/src/plugins/macros/macromanager.cpp b/src/plugins/macros/macromanager.cpp index 32a57c418d..8e57644486 100644 --- a/src/plugins/macros/macromanager.cpp +++ b/src/plugins/macros/macromanager.cpp @@ -74,8 +74,8 @@ using namespace Macros::Internal; \class Macro::MacroManager \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. + The MacroManager manages all macros, loads them on startup, keeps track of the + current macro, and creates new macros. There are two important methods in this class that can be used outside the Macros plugin: \list @@ -89,7 +89,7 @@ using namespace Macros::Internal; /*! \fn void registerAction(QAction *action, const QString &id) - Append this action to the list of actions registered in a macro. The id is + Appends \a action to the list of actions registered in a macro. \a id is the action id passed to the ActionManager. */ diff --git a/src/plugins/projectexplorer/abstractprocessstep.cpp b/src/plugins/projectexplorer/abstractprocessstep.cpp index c611b390ce..768cd9556a 100644 --- a/src/plugins/projectexplorer/abstractprocessstep.cpp +++ b/src/plugins/projectexplorer/abstractprocessstep.cpp @@ -72,18 +72,18 @@ using namespace ProjectExplorer; /*! \fn void ProjectExplorer::AbstractProcessStep::setEnabled(bool b) - \brief Enables or disables a BuildStep. + Enables or disables a BuildStep. Disabled BuildSteps immediately return true from their run method. - Should be called from init() + Should be called from init(). */ /*! \fn ProcessParameters *ProjectExplorer::AbstractProcessStep::processParameters() - \brief Obtain a reference to the parameters for the actual process to run. + Obtains a reference to the parameters for the actual process to run. - Should be used in init() + Should be used in init(). */ AbstractProcessStep::AbstractProcessStep(BuildStepList *bsl, const Core::Id id) : @@ -110,7 +110,7 @@ AbstractProcessStep::~AbstractProcessStep() } /*! - \brief Delete all existing output parsers and start a new chain with the + Deletes all existing output parsers and starts a new chain with the given parser. Derived classes need to call this function. @@ -131,7 +131,7 @@ void AbstractProcessStep::setOutputParser(ProjectExplorer::IOutputParser *parser } /*! - \brief Append the given output parser to the existing chain of parsers. + Appends the given output parser to the existing chain of parsers. */ void AbstractProcessStep::appendOutputParser(ProjectExplorer::IOutputParser *parser) @@ -155,7 +155,7 @@ bool AbstractProcessStep::ignoreReturnValue() } /*! - \brief If ignoreReturnValue is set to true, then the abstractprocess step will + If \a ignoreReturnValue is set to true, then the abstractprocess step will return success even if the return value indicates otherwise. Should be called from init. @@ -167,8 +167,8 @@ void AbstractProcessStep::setIgnoreReturnValue(bool b) } /*! - \brief Reimplemented from BuildStep::init(). You need to call this from - YourBuildStep::init() + Reimplemented from BuildStep::init(). You need to call this from + YourBuildStep::init(). */ bool AbstractProcessStep::init() @@ -177,7 +177,8 @@ bool AbstractProcessStep::init() } /*! - \brief Reimplemented from BuildStep::init(). You need to call this from YourBuildStep::run() + Reimplemented from BuildStep::init(). You need to call this from + YourBuildStep::run(). */ void AbstractProcessStep::run(QFutureInterface<bool> &fi) @@ -241,9 +242,10 @@ void AbstractProcessStep::cleanUp() } /*! - \brief Called after the process is started. + Called after the process is started. - The default implementation adds a process started message to the output message + The default implementation adds a process-started message to the output + message. */ void AbstractProcessStep::processStarted() @@ -255,9 +257,9 @@ void AbstractProcessStep::processStarted() } /*! - \brief Called after the process Finished. + Called after the process is finished. - The default implementation adds a line to the output window + The default implementation adds a line to the output window. */ void AbstractProcessStep::processFinished(int exitCode, QProcess::ExitStatus status) @@ -279,9 +281,9 @@ void AbstractProcessStep::processFinished(int exitCode, QProcess::ExitStatus sta } /*! - \brief Called if the process could not be started. + Called if the process could not be started. - By default adds a message to the output window. + By default, adds a message to the output window. */ void AbstractProcessStep::processStartupFailed() @@ -293,7 +295,7 @@ void AbstractProcessStep::processStartupFailed() } /*! - \brief Called to test whether a prcess succeeded or not. + Called to test whether a process succeeded or not. */ bool AbstractProcessStep::processSucceeded(int exitCode, QProcess::ExitStatus status) @@ -314,7 +316,7 @@ void AbstractProcessStep::processReadyReadStdOutput() } /*! - \brief Called for each line of output on stdOut(). + Called for each line of output on stdOut(). The default implementation adds the line to the application output window. */ @@ -336,9 +338,9 @@ void AbstractProcessStep::processReadyReadStdError() } /*! - \brief Called for each line of output on StdErrror(). + Called for each line of output on StdErrror(). - The default implementation adds the line to the application output window + The default implementation adds the line to the application output window. */ void AbstractProcessStep::stdError(const QString &line) diff --git a/src/plugins/projectexplorer/buildconfigurationmodel.cpp b/src/plugins/projectexplorer/buildconfigurationmodel.cpp index 8c6a955d61..8d56e72e0e 100644 --- a/src/plugins/projectexplorer/buildconfigurationmodel.cpp +++ b/src/plugins/projectexplorer/buildconfigurationmodel.cpp @@ -38,8 +38,8 @@ using namespace ProjectExplorer; \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 + To be used in the dropdown lists of comboboxes. + Automatically adjusts 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 dc23c2543b..22fe07b4e0 100644 --- a/src/plugins/projectexplorer/buildstep.cpp +++ b/src/plugins/projectexplorer/buildstep.cpp @@ -60,15 +60,15 @@ /*! \fn bool ProjectExplorer::BuildStep::init() - This function is run in the gui thread, - use it to retrieve any information that you need in run() + This function is run in the GUI thread. Use it to retrieve any information + that you need in the run() function. */ /*! \fn void ProjectExplorer::BuildStep::run(QFutureInterface<bool> &fi) - Reimplement this. This function is called when the target is build. - By default this function is NOT run in the gui thread. It runs in its + Reimplement this function. It is called when the target is built. + By default, this function is NOT run in the GUI thread, but runs in its own thread. If you need an event loop, you need to create one. This function should block until the task is done @@ -77,48 +77,36 @@ fi.reportResult(true); \endcode - By returning true from \sa runInGuiThread() this function is called in the - gui thread. Then the function should not block and instead the + By returning \c true from runInGuiThread(), this function is called in + the GUI thread. Then the function should not block and instead the finished() signal should be emitted. -*/ - -/*! - \fn BuildStepConfigWidget *ProjectExplorer::BuildStep::createConfigWidget() - Returns the Widget shown in the target settings dialog for this buildStep; - ownership is transferred to the caller. + \sa runInGuiThread() */ /*! - \fn bool ProjectExplorer::BuildStep::immutable() const + \fn BuildStepConfigWidget *ProjectExplorer::BuildStep::createConfigWidget() - If this function returns true, the user can't delete this BuildStep for this target - and the user is prevented from changing the order immutable steps are run - the default implementation returns false. + Returns the Widget shown in the target settings dialog for this build step. + Ownership is transferred to the caller. */ /*! \fn void ProjectExplorer::BuildStep::addTask(const ProjectExplorer::Task &task) - \brief Add a task. + Adds \a task. */ /*! \fn void ProjectExplorer::BuildStep::addOutput(const QString &string, ProjectExplorer::BuildStep::OutputFormat format, ProjectExplorer::BuildStep::OutputNewlineSetting newlineSetting = DoAppendNewline) const - The string is added to the generated output, usually in the output window. + The \a string is added to the generated output, usually in the output pane. It should be in plain text, with the format in the parameter. */ /*! - \fn void ProjectExplorer::BuildStep::cancel() - - This function needs to be reimplemented only for BuildSteps that return false from \sa runInGuiThread. -*/ - -/*! \fn void ProjectExplorer::BuildStep::finished() - \brief This signal needs to be emitted if the BuildStep runs in the gui thread. + This signal needs to be emitted if the build step runs in the GUI thread. */ static const char buildStepEnabledKey[] = "ProjectExplorer.BuildStep.Enabled"; @@ -180,6 +168,12 @@ Project *BuildStep::project() const return target()->project(); } +/*! + If this function returns \c true, the user cannot delete this build step for + this target and the user is prevented from changing the order in which + immutable steps are run. The default implementation returns \c false. +*/ + bool BuildStep::immutable() const { return false; @@ -190,6 +184,12 @@ bool BuildStep::runInGuiThread() const return false; } +/*! + This function needs to be reimplemented only for build steps that return + \c false from runInGuiThread(). + + \sa runInGuiThread() +*/ void BuildStep::cancel() { // Do nothing diff --git a/src/plugins/projectexplorer/customwizard/customwizard.cpp b/src/plugins/projectexplorer/customwizard/customwizard.cpp index 857eea7782..e8c720f9e6 100644 --- a/src/plugins/projectexplorer/customwizard/customwizard.cpp +++ b/src/plugins/projectexplorer/customwizard/customwizard.cpp @@ -397,7 +397,7 @@ static QString listWizards() } /*! - \brief Reads \c share/qtcreator/templates/wizards and creates all custom wizards. + Reads \c share/qtcreator/templates/wizards and creates all custom wizards. As other plugins might register factories for derived classes, call it in extensionsInitialized(). @@ -496,7 +496,7 @@ QList<CustomWizard*> CustomWizard::createWizards() /*! \class ProjectExplorer::CustomProjectWizard - \brief A custom project wizard. + \brief The CustomProjectWizard class provides a custom project wizard. Presents a CustomProjectWizardDialog (Project intro page and fields page) for wizards of type "project". @@ -511,7 +511,7 @@ CustomProjectWizard::CustomProjectWizard() } /*! - \brief Can be reimplemented to create custom project wizards. + Can be reimplemented to create custom project wizards. initProjectWizardDialog() needs to be called. */ @@ -575,7 +575,7 @@ Core::GeneratedFiles CustomProjectWizard::generateFiles(const QWizard *w, QStrin } /*! - \brief Utility to open the projects and editors for the files that have + Opens the projects and editors for the files that have the respective attributes set. */ diff --git a/src/plugins/projectexplorer/customwizard/customwizardpage.cpp b/src/plugins/projectexplorer/customwizard/customwizardpage.cpp index 5e847e63b0..dc9e218d71 100644 --- a/src/plugins/projectexplorer/customwizard/customwizardpage.cpp +++ b/src/plugins/projectexplorer/customwizard/customwizardpage.cpp @@ -114,7 +114,8 @@ QString TextFieldComboBox::valueAt(int i) const \brief The TextFieldCheckBox class is a aheckbox that plays with \c QWizard::registerField. - Provides a settable 'text' property containing predefined strings for 'true'/'false'). + Provides a settable 'text' property containing predefined strings for + \c true and \c false. \sa ProjectExplorer::Internal::CustomWizardFieldPage, ProjectExplorer::CustomWizard */ @@ -216,8 +217,8 @@ void CustomWizardFieldPage::clearError() } /*! - \brief Create widget a control based on the control attributes map - and register it with the QWizard. + Creates a widget based on the control attributes map and registers it with + the QWizard. */ void CustomWizardFieldPage::addField(const CustomWizardField &field)\ @@ -507,7 +508,8 @@ QMap<QString, QString> CustomWizardFieldPage::replacementMap(const QWizard *w, /*! \class ProjectExplorer::Internal::CustomWizardPage - \brief A custom wizard page presenting the fields to be used and a path chooser + \brief The CustomWizardPage class provides a custom wizard page presenting + the fields to be used and a path chooser at the bottom (for use by "class"/"file" wizards). Does validation on the Path chooser only (as the other fields can by validated by regexps). diff --git a/src/plugins/projectexplorer/customwizard/customwizardparameters.cpp b/src/plugins/projectexplorer/customwizard/customwizardparameters.cpp index 718cc89097..8cb99a3d93 100644 --- a/src/plugins/projectexplorer/customwizard/customwizardparameters.cpp +++ b/src/plugins/projectexplorer/customwizard/customwizardparameters.cpp @@ -878,9 +878,7 @@ bool replaceFieldHelper(ValueStringTransformation transform, } /*! - \brief Performs field replacements. - - Replace field values delimited by '%' with special modifiers: + Replaces field values delimited by '%' with special modifiers: \list \li %Field% -> simple replacement \li %Field:l% -> replace with everything changed to lower case @@ -939,12 +937,13 @@ QString TemporaryFileTransform::operator()(const QString &value) const /*! \class ProjectExplorer::Internal::CustomWizardContext - \brief Context used for one custom wizard run. + \brief The CustomWizardContext class provides the context for one custom + wizard run. Shared between CustomWizard and the CustomWizardPage as it is used for the QLineEdit-type fields' default texts as well. Contains basic replacement fields - like \c '%CppSourceSuffix%', \c '%CppHeaderSuffix%' (settings-dependent) + like \c '%CppSourceSuffix%', \c '%CppHeaderSuffix%' (settings-dependent). reset() should be called before each wizard run to refresh them. CustomProjectWizard additionally inserts \c '%ProjectName%' from the intro page to have it available for default texts. @@ -953,11 +952,13 @@ QString TemporaryFileTransform::operator()(const QString &value) const */ /*! - \brief Special replaceFields() overload used for the arguments of a generator + This function is a special replaceFields() overload used for the arguments + of a generator script. - Write the expanded field values out to temporary files and - inserts file names instead of the expanded fields in string 's'. + Writes the expanded field values out to temporary files specified by + \a files and inserts file names instead of the expanded fields in the + string \a s. */ bool CustomWizardContext::replaceFields(const FieldReplacementMap &fm, QString *s, diff --git a/src/plugins/projectexplorer/customwizard/customwizardpreprocessor.cpp b/src/plugins/projectexplorer/customwizard/customwizardpreprocessor.cpp index 01d90f53e4..8884772263 100644 --- a/src/plugins/projectexplorer/customwizard/customwizardpreprocessor.cpp +++ b/src/plugins/projectexplorer/customwizard/customwizardpreprocessor.cpp @@ -260,9 +260,9 @@ bool PreprocessContext::process(const QString &in, QString *out, QString *errorM } /*! - \brief Custom wizard preprocessor based on JavaScript expressions. + Implements a custom wizard preprocessor based on JavaScript expressions. - Preprocess a string using simple syntax: + Preprocesses a string using a simple syntax: \code Text @if <JavaScript-expression> @@ -274,7 +274,7 @@ Blup The JavaScript-expressions must evaluate to integers or boolean, like \c '2 == 1 + 1', \c '"a" == "a"'. The variables of the custom wizard will be - expanded before, so , \c "%VAR%" should be used for strings and \c %VAR% for integers. + expanded before, so \c "%VAR%" should be used for strings and \c %VAR% for integers. \sa ProjectExplorer::CustomWizard */ diff --git a/src/plugins/projectexplorer/customwizard/customwizardscriptgenerator.cpp b/src/plugins/projectexplorer/customwizard/customwizardscriptgenerator.cpp index e6ed595bc3..23355590c1 100644 --- a/src/plugins/projectexplorer/customwizard/customwizardscriptgenerator.cpp +++ b/src/plugins/projectexplorer/customwizard/customwizardscriptgenerator.cpp @@ -145,9 +145,9 @@ static bool } /*! - \brief Custom wizard script generator function (Step1) - dry run. + Performs the first step in custom wizard script generation. - Do a dry run of the generation script to get a list of files + Does a dry run of the generation script to get a list of files. \sa runCustomWizardGeneratorScript, ProjectExplorer::CustomWizard */ @@ -205,11 +205,12 @@ Core::GeneratedFiles } /*! - \brief Custom wizard script generator function (Step2) - actual file creation. + Performs the second step in custom wizard script generation by actually + creating the files. In addition to the <file> elements that define template files in which macros are replaced, it is possible to have - a custom wizard call a generation script (specified in the "generatorscript" + a custom wizard call a generation script (specified in the \a generatorscript attribute of the <files> element) which actually creates files. The command line of the script must follow the convention \code @@ -219,7 +220,7 @@ Core::GeneratedFiles Options containing field placeholders are configured in the XML files and will be passed with them replaced by their values. - As Qt Creator needs to know the file names before actually creates them to + As \QC needs to know the file names before it actually creates the files to do overwrite checking etc., this is 2-step process: \list \li Determine file names and attributes: The script is called with the diff --git a/src/plugins/projectexplorer/deployconfigurationmodel.cpp b/src/plugins/projectexplorer/deployconfigurationmodel.cpp index c2c66d4436..2f30be1451 100644 --- a/src/plugins/projectexplorer/deployconfigurationmodel.cpp +++ b/src/plugins/projectexplorer/deployconfigurationmodel.cpp @@ -39,8 +39,8 @@ using namespace ProjectExplorer; \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 + To be used in drop down lists of comboboxes. Automatically adjusts + itself to added and removed deploy configurations. */ class DeployConfigurationComparer diff --git a/src/plugins/projectexplorer/devicesupport/deviceprocessesdialog.cpp b/src/plugins/projectexplorer/devicesupport/deviceprocessesdialog.cpp index 1b13f5d561..5f898465cd 100644 --- a/src/plugins/projectexplorer/devicesupport/deviceprocessesdialog.cpp +++ b/src/plugins/projectexplorer/devicesupport/deviceprocessesdialog.cpp @@ -298,13 +298,13 @@ DeviceProcessItem DeviceProcessesDialogPrivate::selectedProcess() const \brief The DeviceProcessesDialog class shows a list of processes. - The dialog can be used as a + The dialog can be used as a: \list - \li Non-modal dialog showing a list of processes: Call addCloseButton() - to add a 'Close' button. - \li Modal dialog with an 'Accept' button to select a process: Call - addAcceptButton() passing the label text. This will create a - 'Cancel' button as well. + \li Non-modal dialog showing a list of processes. Call addCloseButton() + to add a \gui Close button. + \li Modal dialog with an \gui Accept button to select a process. Call + addAcceptButton() passing the label text. This will create a + \gui Cancel button as well. \endlist */ diff --git a/src/plugins/projectexplorer/devicesupport/idevice.cpp b/src/plugins/projectexplorer/devicesupport/idevice.cpp index 11044fba2e..304991c86d 100644 --- a/src/plugins/projectexplorer/devicesupport/idevice.cpp +++ b/src/plugins/projectexplorer/devicesupport/idevice.cpp @@ -45,98 +45,56 @@ * \class ProjectExplorer::IDevice * \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. + * The term \e device refers to some host to which files can be deployed or on + * which an application can run, for example. * In the typical case, this would be some sort of embedded computer connected in some way to - * the PC on which QtCreator runs. This class itself does not specify a connection protocol; that + * the PC on which \QC runs. This class itself does not specify a connection + * protocol; that * kind of detail is to be added by subclasses. * Devices are managed by a \c DeviceManager. * \sa ProjectExplorer::DeviceManager */ /*! - * \fn QString ProjectExplorer::IDevice::type() const - * \brief Identifies the type of the device. - * Devices with the same type share certain abilities. - * This attribute is immutable. - * \sa ProjectExplorer::IDeviceFactory - */ - - -/*! - * \fn QString ProjectExplorer::IDevice::displayName() const - * \brief A free-text name for the device to be displayed in GUI elements. - */ - -/*! - * \fn bool ProjectExplorer::IDevice::isAutoDetected() const - * \brief True iff the device has been added via some sort of auto-detection mechanism. - * Devices that are not auto-detected can only ever be created interactively from the - * settings page. - * This attribute is immutable. - * \sa DeviceSettingsWidget - */ - -/*! - * \fn Core::Id ProjectExplorer::IDevice::id() const - * \brief Identify the device. - * If an id is given when constructing a device then this id is used. Otherwise a UUID is - * generated and used to identity the device. - * \sa ProjectExplorer::DeviceManager::findInactiveAutoDetectedDevice() - */ - -/*! * \fn Core::Id ProjectExplorer::IDevice::invalidId() - * \brief A value that no device can ever have as its internal id. + * A value that no device can ever have as its internal id. */ /*! * \fn QString ProjectExplorer::IDevice::displayType() const - * \brief Prints a representation of the device's type suitable for displaying to a user. + * Prints a representation of the device's type suitable for displaying to a + * user. */ /*! * \fn ProjectExplorer::IDeviceWidget *ProjectExplorer::IDevice::createWidget() - * \brief Creates a widget that displays device information not part of the IDevice base class. + * Creates a widget that displays device information not part of the IDevice base class. * The widget can also be used to let the user change these attributes. */ /*! * \fn QStringList ProjectExplorer::IDevice::actionIds() const - * \brief Returns a list of ids representing actions that can be run on this device. - * These actions will be available in the "Devices" options page. + * Returns a list of ids representing actions that can be run on this device. + * These actions will be available in the \gui Devices options page. */ /*! * \fn QString ProjectExplorer::IDevice::displayNameForActionId(Core::Id actionId) const - * \brief A human-readable string for the given id. Will be displayed on a button which, + * A human-readable string for \a actionId. Will be displayed on a button which, * when clicked, starts the respective action. */ /*! * \fn void ProjectExplorer::IDevice::executeAction(Core::Id actionId, QWidget *parent) const - * \brief Executes the respective action. This is typically done via some sort of dialog or - * wizard, so a parent widget argument is provided. + * Executes the action specified by \a actionId. This is typically done via some + * sort of dialog or wizard, so \a parent widget is provided. */ /*! * \fn ProjectExplorer::IDevice::Ptr ProjectExplorer::IDevice::clone() const - * \brief Creates an identical copy of a device object. + * Creates an identical copy of a device object. */ -/*! - * \fn void ProjectExplorer::IDevice::fromMap(const QVariantMap &map) - * \brief Restores a device object from a serialized state as written by \c toMap(). - * If subclasses override this to restore additional state, they must call the base class - * implementation. - */ - -/*! - * \fn ProjectExplorer::IDevice::toMap() const - * \brief Serializes a device object, e.g. to save it to a file. - * If subclasses override this to save additional state, they must call the base class - * implementation. - */ static Core::Id newId() { @@ -221,6 +179,10 @@ IDevice::~IDevice() delete d; } +/*! + Specifies a free-text name for the device to be displayed in GUI elements. +*/ + QString IDevice::displayName() const { return d->displayName; @@ -239,16 +201,39 @@ IDevice::DeviceInfo IDevice::deviceInformation() const return DeviceInfo() << IDevice::DeviceInfoItem(key, deviceStateToString()); } +/*! + Identifies the type of the device. Devices with the same type share certain + abilities. This attribute is immutable. + + \sa ProjectExplorer::IDeviceFactory + */ + Core::Id IDevice::type() const { return d->type; } +/*! + Returns \c true if the device has been added via some sort of auto-detection + mechanism. Devices that are not auto-detected can only ever be created + interactively from the \gui Options page. This attribute is immutable. + + \sa DeviceSettingsWidget +*/ + bool IDevice::isAutoDetected() const { return d->origin == AutoDetected; } +/*! + Identifies the device. If an id is given when constructing a device then + this id is used. Otherwise, a UUID is generated and used to identity the + device. + + \sa ProjectExplorer::DeviceManager::findInactiveAutoDetectedDevice() +*/ + Core::Id IDevice::id() const { return d->id; @@ -300,6 +285,12 @@ Core::Id IDevice::idFromMap(const QVariantMap &map) return Core::Id::fromSetting(map.value(QLatin1String(IdKey))); } +/*! + Restores a device object from a serialized state as written by toMap(). + If subclasses override this to restore additional state, they must call the + base class implementation. +*/ + void IDevice::fromMap(const QVariantMap &map) { d->type = typeFromMap(map); @@ -326,6 +317,12 @@ void IDevice::fromMap(const QVariantMap &map) d->debugServerPath = map.value(QLatin1String(DebugServerKey)).toString(); } +/*! + Serializes a device object, for example to save it to a file. + If subclasses override this function to save additional state, they must + call the base class implementation. +*/ + QVariantMap IDevice::toMap() const { QVariantMap map; diff --git a/src/plugins/projectexplorer/devicesupport/idevicewidget.cpp b/src/plugins/projectexplorer/devicesupport/idevicewidget.cpp new file mode 100644 index 0000000000..c7b0be4ee4 --- /dev/null +++ b/src/plugins/projectexplorer/devicesupport/idevicewidget.cpp @@ -0,0 +1,51 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of Qt Creator. +** +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Digia gives you certain additional +** rights. These rights are described in the Digia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +****************************************************************************/ +#include <idevicewidget.h> + +/*! + \class ProjectExplorer::IDeviceWidget + \brief The IDeviceWidget class provides an interface for the widget + configuring an IDevice. + + A class implementing this interface will display a widget on the + \gui Devices options page. It enables the user to configure a particular + device. +*/ + +/*! + \fn virtual void updateDeviceFromUi() + + Ensures that all changes in the UI are propagated to the device object. + + If the device is always updated right when the change happens, the + implementation of this function can be empty. However, you cannot generally + rely on the QLineEdit::editingFinished() signal being emitted on time if + some button in the dialog is clicked (such as \gui Apply). So if you have + any handlers for line edit changes, they should probably be called here. +*/ diff --git a/src/plugins/projectexplorer/devicesupport/idevicewidget.h b/src/plugins/projectexplorer/devicesupport/idevicewidget.h index 19fb750954..9c728ddd51 100644 --- a/src/plugins/projectexplorer/devicesupport/idevicewidget.h +++ b/src/plugins/projectexplorer/devicesupport/idevicewidget.h @@ -36,30 +36,11 @@ namespace ProjectExplorer { -/*! - \class ProjectExplorer::IDeviceWidget - - \brief Provides an interface for the widget configuring an IDevice. - - A class implementing this interface will display a widget in the configuration - options page "Devices". - It is used to let the user configure a particular device. -*/ - class PROJECTEXPLORER_EXPORT IDeviceWidget : public QWidget { Q_OBJECT public: - /*! - * \brief Ensures that all changes in the UI are propagated to the device object. - * - * If the device is always updated right when the change happens, the implementation of - * this function can be empty. Note, however, that you cannot generally rely on the - * QLineEdit::editingFinished() signal being emitted on time if some button in the dialog is - * clicked (e.g. "Apply"). So if you have any handlers for line edit changes, they should - * probably be called here. - */ virtual void updateDeviceFromUi() = 0; protected: diff --git a/src/plugins/projectexplorer/gcctoolchain.cpp b/src/plugins/projectexplorer/gcctoolchain.cpp index f1270fb5e5..3c4325a9aa 100644 --- a/src/plugins/projectexplorer/gcctoolchain.cpp +++ b/src/plugins/projectexplorer/gcctoolchain.cpp @@ -611,7 +611,7 @@ void GccToolChain::setPlatformCodeGenFlags(const QStringList &flags) } /*! - \brief code gen flags that have to be passed to the compiler + Code gen flags that have to be passed to the compiler. */ QStringList GccToolChain::platformCodeGenFlags() const { @@ -627,9 +627,9 @@ void GccToolChain::setPlatformLinkerFlags(const QStringList &flags) } /*! - \brief flags that have to be passed to the linker + Flags that have to be passed to the linker. - for example -arch armv7... + For example: \c{-arch armv7} */ QStringList GccToolChain::platformLinkerFlags() const { diff --git a/src/plugins/projectexplorer/ioutputparser.cpp b/src/plugins/projectexplorer/ioutputparser.cpp index 44f4ed2b6a..ea073d0824 100644 --- a/src/plugins/projectexplorer/ioutputparser.cpp +++ b/src/plugins/projectexplorer/ioutputparser.cpp @@ -42,81 +42,86 @@ /*! \fn void ProjectExplorer::IOutputParser::appendOutputParser(IOutputParser *parser) - \brief Append a subparser to this parser, of which IOutputParser will take ownership. + Appends a subparser to this parser, of which IOutputParser will take + ownership. */ /*! \fn IOutputParser *ProjectExplorer::IOutputParser::takeOutputParserChain() - \brief Remove the appended outputparser chain from this parser, transferring + Removes the appended outputparser chain from this parser, transferring ownership of the parser chain to the caller. */ /*! \fn IOutputParser *ProjectExplorer::IOutputParser::childParser() const - \brief Return the head of this parsers output parser children, IOutputParser keeps ownership. + Returns the head of this parser's output parser children. IOutputParser + keeps ownership. */ /*! \fn void ProjectExplorer::IOutputParser::stdOutput(const QString &line) - \brief Called once for each line if standard output to parse. + Called once for each line if standard output to parse. */ /*! \fn void ProjectExplorer::IOutputParser::stdError(const QString &line) - \brief Called once for each line if standard error to parse. + Called once for each line if standard error to parse. */ /*! \fn bool ProjectExplorer::IOutputParser::hasFatalErrors() const - \brief This is mainly a symbian specific quirk. + This is mainly a Symbian specific quirk. */ /*! \fn void ProjectExplorer::IOutputParser::addOutput(const QString &string, ProjectExplorer::BuildStep::OutputFormat format) - \brief Should be emitted whenever some additional information should be added to the output. + Should be emitted whenever some additional information should be added to the + output. - Note: This is additional information. There is no need to add each line! + \note This is additional information. There is no need to add each line. */ /*! \fn void ProjectExplorer::IOutputParser::addTask(const ProjectExplorer::Task &task) - \brief Should be emitted for each task seen in the output. + Should be emitted for each task seen in the output. */ /*! \fn void ProjectExplorer::IOutputParser::outputAdded(const QString &string, ProjectExplorer::BuildStep::OutputFormat format) - \brief Subparsers have their addOutput signal connected to this slot. + Subparsers have their addOutput signal connected to this slot. */ /*! \fn void ProjectExplorer::IOutputParser::outputAdded(const QString &string, ProjectExplorer::BuildStep::OutputFormat format) - \brief This method can be overwritten to change the string. + This method can be overwritten to change the string. */ /*! \fn void ProjectExplorer::IOutputParser::taskAdded(const ProjectExplorer::Task &task) - \brief Subparsers have their addTask signal connected to this slot. + Subparsers have their addTask signal connected to this slot. This method can be overwritten to change the task. */ /*! \fn void ProjectExplorer::IOutputParser::doFlush() - \brief This method is called whenever a parser is supposed to flush his state. - Parsers may have state (e.g. because they need to aggregate several lines into one task). This + Instructs a parser to flush its state. + Parsers may have state (for example, because they need to aggregate several + lines into one task). This method is called when this state needs to be flushed out to be visible. - doFlush() is called by flush(). flush() is called on childparsers whenever a new task is added. + doFlush() is called by flush(). flush() is called on child parsers + whenever a new task is added. It is also called once when all input has been parsed. */ diff --git a/src/plugins/projectexplorer/processparameters.cpp b/src/plugins/projectexplorer/processparameters.cpp index 649225361d..504c5effda 100644 --- a/src/plugins/projectexplorer/processparameters.cpp +++ b/src/plugins/projectexplorer/processparameters.cpp @@ -57,7 +57,7 @@ ProcessParameters::ProcessParameters() : } /*! - \brief Sets the executable to run. + Sets the executable to run. */ void ProcessParameters::setCommand(const QString &cmd) @@ -67,7 +67,7 @@ void ProcessParameters::setCommand(const QString &cmd) } /*! - \brief Sets the command line arguments used by the process + Sets the command line arguments used by the process. */ void ProcessParameters::setArguments(const QString &arguments) @@ -77,8 +77,9 @@ void ProcessParameters::setArguments(const QString &arguments) } /*! - \brief Sets the workingDirectory for the process for a buildConfiguration - should be called from init() + Sets the \a workingDirectory for the process for a build configuration. + + Should be called from init(). */ void ProcessParameters::setWorkingDirectory(const QString &workingDirectory) @@ -89,20 +90,21 @@ void ProcessParameters::setWorkingDirectory(const QString &workingDirectory) /*! \fn void ProjectExplorer::ProcessParameters::setEnvironment(const Utils::Environment &env) - \brief Set the Environment for running the command + Sets the environment \a env for running the command. - Should be called from init() + Should be called from init(). */ /*! \fn void ProjectExplorer::ProcessParameters::setMacroExpander(Utils::AbstractMacroExpander *mx) - \brief Set the macro expander to use on the command, arguments and working dir. + Sets the macro expander \a mx to use on the command, arguments, and working + dir. - Note that the caller retains ownership of the object. + \note The caller retains ownership of the object. */ /*! - \brief Get the fully expanded working directory. + Gets the fully expanded working directory. */ QString ProcessParameters::effectiveWorkingDirectory() const @@ -117,7 +119,7 @@ QString ProcessParameters::effectiveWorkingDirectory() const } /*! - \brief Get the fully expanded command name to run + Gets the fully expanded command name to run. */ QString ProcessParameters::effectiveCommand() const @@ -136,7 +138,7 @@ QString ProcessParameters::effectiveCommand() const } /*! - \brief True if effectiveCommand() would return only a fallback. + Returns \c true if effectiveCommand() would return only a fallback. */ bool ProcessParameters::commandMissing() const diff --git a/src/plugins/projectexplorer/project.cpp b/src/plugins/projectexplorer/project.cpp index de4aabf4c1..54838549cd 100644 --- a/src/plugins/projectexplorer/project.cpp +++ b/src/plugins/projectexplorer/project.cpp @@ -52,15 +52,17 @@ /*! \fn void ProjectExplorer::Project::environmentChanged() - \brief Convenience signal emitted if the activeBuildConfiguration emits environmentChanged - or if the activeBuildConfiguration changes (including due to the active target changing). + A convenience signal emitted if activeBuildConfiguration emits + environmentChanged or if the active build configuration changes + (including due to the active target changing). */ /*! \fn void ProjectExplorer::Project::buildConfigurationEnabledChanged() - \brief Convenience signal emitted if the activeBuildConfiguration emits isEnabledChanged() - or if the activeBuildConfiguration changes (including due to the active target changing). + A convenience signal emitted if activeBuildConfiguration emits + isEnabledChanged() or if the active build configuration changes + (including due to the active target changing). */ namespace { @@ -304,14 +306,14 @@ bool Project::restoreSettings() /*! - \brief Serialize all data into a QVariantMap. + Serializes all data into a QVariantMap. This map is then saved in the .user file of the project. Just put all your data into the map. \note Do not forget to call your base class' toMap method. \note Do not forget to call setActiveBuildConfiguration when - creating new BuilConfigurations. + creating new build configurations. */ QVariantMap Project::toMap() const diff --git a/src/plugins/projectexplorer/projectexplorer.cpp b/src/plugins/projectexplorer/projectexplorer.cpp index 54fdcd6b0e..ed3aa3739c 100644 --- a/src/plugins/projectexplorer/projectexplorer.cpp +++ b/src/plugins/projectexplorer/projectexplorer.cpp @@ -133,12 +133,13 @@ /*! \namespace ProjectExplorer - ProjectExplorer plugin namespace + The ProjectExplorer namespace contains the classes to explore projects. */ /*! \namespace ProjectExplorer::Internal - Internal namespace of the ProjectExplorer plugin + The ProjectExplorer::Internal namespace is the internal namespace of the + ProjectExplorer plugin. \internal */ diff --git a/src/plugins/projectexplorer/projectfilewizardextension.cpp b/src/plugins/projectexplorer/projectfilewizardextension.cpp index bb2f72608b..05fd1c2cf3 100644 --- a/src/plugins/projectexplorer/projectfilewizardextension.cpp +++ b/src/plugins/projectexplorer/projectfilewizardextension.cpp @@ -68,10 +68,10 @@ \brief The ProjectFileWizardExtension class implements the post-file generating steps of a project wizard. - Offers: + This class provides the following functions: \list \li Add to a project file (*.pri/ *.pro) - \li Initialize a version control repository (unless the path is already + \li Initialize a version control system repository (unless the path is already managed) and do 'add' if the VCS supports it. \endlist diff --git a/src/plugins/projectexplorer/projectnodes.cpp b/src/plugins/projectexplorer/projectnodes.cpp index bbc66282d4..e1f97cf178 100644 --- a/src/plugins/projectexplorer/projectnodes.cpp +++ b/src/plugins/projectexplorer/projectnodes.cpp @@ -89,9 +89,10 @@ void Node::emitNodeSortKeyChanged() } /*! - * \brief The path of the file representing this node. + * The path of the file representing this node. * - * This method does not emit any signals, that has to be done by the calling class! + * This method does not emit any signals. That has to be done by the calling + * class. */ void Node::setPath(const QString &path) { @@ -110,7 +111,8 @@ NodeType Node::nodeType() const } /*! - \brief Project that owns & manages the node. It's the first project in list of ancestors. + The project that owns and manages the node. It is the first project in the list + of ancestors. */ ProjectNode *Node::projectNode() const { @@ -118,7 +120,7 @@ ProjectNode *Node::projectNode() const } /*! - \brief Parent in node hierarchy. + The parent in the node hierarchy. */ FolderNode *Node::parentFolderNode() const { @@ -126,7 +128,7 @@ FolderNode *Node::parentFolderNode() const } /*! - \brief Path of file or folder in the filesystem the node represents. + The path of the file or folder in the filesystem the node represents. */ QString Node::path() const { @@ -183,7 +185,9 @@ void Node::setParentFolderNode(FolderNode *parentFolder) /*! \class ProjectExplorer::FileNode - \brief In-memory presentation of a file. All FileNode's are leaf nodes. + \brief The FileNode class is an in-memory presentation of a file. + + All file nodes are leaf nodes. \sa ProjectExplorer::FolderNode, ProjectExplorer::ProjectNode */ @@ -203,7 +207,7 @@ FileType FileNode::fileType() const } /*! - \brief Returns true if the file is automatically generated by a compile step. + Returns \c true if the file is automatically generated by a compile step. */ bool FileNode::isGenerated() const { @@ -230,7 +234,7 @@ FolderNode::~FolderNode() } /*! - \brief The display name that should be used in a view. + Contains the display name that should be used in a view. \sa setFolderName() */ @@ -240,7 +244,8 @@ QString FolderNode::displayName() const } /*! - \brief The icon that should be used in a view. Default is the directory icon (QStyle::S_PDirIcon). + Contains the icon that should be used in a view. Default is the directory icon + (QStyle::S_PDirIcon). s\a setIcon() */ QIcon FolderNode::icon() const @@ -329,15 +334,15 @@ int VirtualFolderNode::priority() const /*! \class ProjectExplorer::ProjectNode - \brief In-memory presentation of a Project. + \brief The ProjectNode class is an in-memory presentation of a Project. - A concrete subclass must implement the "persistent" stuff + A concrete subclass must implement the persistent data. \sa ProjectExplorer::FileNode, ProjectExplorer::FolderNode */ /*! - \brief Creates uninitialized ProjectNode object. + Creates an uninitialized project node object. */ ProjectNode::ProjectNode(const QString &projectFilePath) : FolderNode(projectFilePath) @@ -408,7 +413,7 @@ QList<NodesWatcher*> ProjectNode::watchers() const } /*! - \brief Registers a watcher for the current project & all sub projects + Registers \a watcher for the current project and all subprojects. It does not take ownership of the watcher. */ @@ -425,7 +430,7 @@ void ProjectNode::registerWatcher(NodesWatcher *watcher) } /*! - \brief Removes a watcher for the current project & all sub projects. + Removes \a watcher from the current project and all subprojects. */ void ProjectNode::unregisterWatcher(NodesWatcher *watcher) { @@ -445,7 +450,8 @@ void ProjectNode::accept(NodesVisitor *visitor) } /*! - \brief Adds project nodes to the hierarchy and emits the corresponding signals. + Adds project nodes specified by \a subProjects to the node hierarchy and + emits the corresponding signals. */ void ProjectNode::addProjectNodes(const QList<ProjectNode*> &subProjects) { @@ -475,9 +481,10 @@ void ProjectNode::addProjectNodes(const QList<ProjectNode*> &subProjects) } /*! - \brief Remove project nodes from the hierarchy and emits the corresponding signals. + Removes project nodes specified by \a subProjects from the node hierarchy + and emits the corresponding signals. - All objects in the argument list are deleted. + All objects in the \a subProjects list are deleted. */ void ProjectNode::removeProjectNodes(const QList<ProjectNode*> &subProjects) @@ -516,7 +523,8 @@ void ProjectNode::removeProjectNodes(const QList<ProjectNode*> &subProjects) } /*! - \brief Adds folder nodes to the hierarchy and emits the corresponding signals. + Adds folder nodes specified by \a subFolders to the node hierarchy below + \a parentFolder and emits the corresponding signals. */ void ProjectNode::addFolderNodes(const QList<FolderNode*> &subFolders, FolderNode *parentFolder) { @@ -561,9 +569,10 @@ void ProjectNode::addFolderNodes(const QList<FolderNode*> &subFolders, FolderNod } /*! - \brief Remove file nodes from the hierarchy and emits the corresponding signals. + Removes file nodes specified by \a subFolders from the node hierarchy and emits + the corresponding signals. - All objects in the subFolders list are deleted. + All objects in the \a subFolders list are deleted. */ void ProjectNode::removeFolderNodes(const QList<FolderNode*> &subFolders, FolderNode *parentFolder) @@ -601,9 +610,11 @@ void ProjectNode::removeFolderNodes(const QList<FolderNode*> &subFolders, } /*! - \brief Adds file nodes to the internal list and emits the corresponding signals. + Adds file nodes specified by \a files to the internal list in the location + specified by \a folder and emits the corresponding signals. - This method should be called within an implementation of the public method addFiles. + This method should be called within an implementation of the public method + addFiles. */ void ProjectNode::addFileNodes(const QList<FileNode*> &files, FolderNode *folder) @@ -644,10 +655,11 @@ void ProjectNode::addFileNodes(const QList<FileNode*> &files, FolderNode *folder } /*! - \brief Remove file nodes from the internal list and emits the corresponding signals. + Removes \a files from the internal list and emits the corresponding signals. - All objects in the argument list are deleted. - This method should be called within an implementation of the public method removeFiles. + All objects in the \a files list are deleted. + This method should be called within an implementation of the public method + removeFiles. */ void ProjectNode::removeFileNodes(const QList<FileNode*> &files, FolderNode *folder) @@ -706,7 +718,7 @@ QList<NodesWatcher*> SessionNode::watchers() const } /*! - \brief Registers a watcher for the complete session tree. + Registers \a watcher for the complete session tree. It does not take ownership of the watcher. */ @@ -722,7 +734,7 @@ void SessionNode::registerWatcher(NodesWatcher *watcher) } /*! - \brief Removes a watcher from the complete session tree + Removes \a watcher from the complete session tree. */ void SessionNode::unregisterWatcher(NodesWatcher *watcher) @@ -818,17 +830,18 @@ void SessionNode::watcherDestroyed(QObject *watcher) /*! \class ProjectExplorer::NodesWatcher - \brief NodesWatcher lets you keep track of changes in the tree. + \brief The NodesWatcher class enables you to keep track of changes in the + tree. Add a watcher by calling ProjectNode::registerWatcher() or SessionNode::registerWatcher(). Whenever the tree underneath the - ProectNode or SessionNode changes (e.g. nodes are added/removed), - the corresponding signals of the NodesWatcher are emitted. + project node or session node changes (for example, nodes are added or removed), + the corresponding signals of the watcher are emitted. Watchers can be removed from the complete tree or a subtree by calling ProjectNode::unregisterWatcher and SessionNode::unregisterWatcher(). - The NodesWatcher is similar to the Observer in the + The NodesWatcher class is similar to the Observer class in the well-known Observer pattern (Booch et al). \sa ProjectExplorer::Node diff --git a/src/plugins/projectexplorer/publishing/ipublishingwizardfactory.cpp b/src/plugins/projectexplorer/publishing/ipublishingwizardfactory.cpp new file mode 100644 index 0000000000..87a4fd5beb --- /dev/null +++ b/src/plugins/projectexplorer/publishing/ipublishingwizardfactory.cpp @@ -0,0 +1,78 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of Qt Creator. +** +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Digia gives you certain additional +** rights. These rights are described in the Digia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +****************************************************************************/ +#include <ipublishingwizardfactory.h> + + +/*! + \class ProjectExplorer::IPublishingWizardFactory + + \brief The IPublishingWizardFactory class provides an interface for creating + wizards to publish a project. + + A class implementing this interface is used to create an associated wizard + that allows users to publish their project to a remote facility, such as an + app store. + + Such a wizard would typically transform the project content into a format + expected by that facility (\e packaging) and also upload it, if possible. + + The factory objects have to be added to the global object pool via + \c ExtensionSystem::PluginManager::addObject(). + + \sa ExtensionSystem::PluginManager::addObject() +*/ + +/*! + \fn virtual QString displayName() const = 0 + + Describes on one line the type of wizard that this factory can create. +*/ + + /*! + \fn virtual QString description() const = 0 + + Explains the exact purpose of the wizard created by this factory. +*/ + +/*! + \fn virtual bool canCreateWizard(const Project *project) const = 0 + + Returns true if the type of wizard that this factory can create is available + for the specified \a project. +*/ + +/*! + \fn virtual QWizard *createWizard(const Project *project) const = 0 + + Creates a wizard that can publish \a project. Behavior is undefined if + canCreateWizard() returns \c false for the project. Returns the newly + created publishing wizard + + \sa canCreateWizard() +*/ diff --git a/src/plugins/projectexplorer/publishing/ipublishingwizardfactory.h b/src/plugins/projectexplorer/publishing/ipublishingwizardfactory.h index 25b35c805f..cf0d62acb9 100644 --- a/src/plugins/projectexplorer/publishing/ipublishingwizardfactory.h +++ b/src/plugins/projectexplorer/publishing/ipublishingwizardfactory.h @@ -39,52 +39,18 @@ namespace ProjectExplorer { class Project; -/*! - \class ProjectExplorer::IPublishingWizardFactory - - \brief Provides an interface for creating wizards to publish a project. - - A class implementing this interface is used to create an associated wizard - that allows users to publish their project to a remote facility, e.g. an - app store. - Such a wizard would typically transform the project's content into - a form expected by that facility ("packaging") and also upload it, if possible. - - The factory objects have to be added to the global object pool via - \c ExtensionSystem::PluginManager::addObject(). - \sa ExtensionSystem::PluginManager::addObject() -*/ - class PROJECTEXPLORER_EXPORT IPublishingWizardFactory : public QObject { Q_OBJECT public: - /*! - A short, one-line description of the type of wizard that this - factory can create. - */ + virtual QString displayName() const = 0; - /*! - A longer description explaining the exact purpose of the wizard - created by this factory. - */ virtual QString description() const = 0; - /*! - Returns true iff the type of wizard that this factory can create - is available for the given project. - */ virtual bool canCreateWizard(const Project *project) const = 0; - /*! - Creates a wizard that can publish the given project. - Behavior is undefined if canCreateWizard() returns false for - that project. - \return The newly created publishing wizard - \sa canCreateWizard() - */ virtual QWizard *createWizard(const Project *project) const = 0; protected: diff --git a/src/plugins/projectexplorer/runconfiguration.cpp b/src/plugins/projectexplorer/runconfiguration.cpp index 6bc0227173..9f08ff1860 100644 --- a/src/plugins/projectexplorer/runconfiguration.cpp +++ b/src/plugins/projectexplorer/runconfiguration.cpp @@ -56,8 +56,8 @@ using namespace ProjectExplorer; \class ProjectExplorer::ProcessHandle \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). + Encapsulates parameters of a running process, local (PID) or remote (to be + done, address, port, and so on). */ ProcessHandle::ProcessHandle(quint64 pid) : @@ -129,7 +129,8 @@ IRunConfigurationAspect::~IRunConfigurationAspect() } /*! - \brief Returns the widget used to configure this run configuration. Ownership is transferred to the caller + Returns the widget used to configure this run configuration. Ownership is + transferred to the caller. */ RunConfigWidget *IRunConfigurationAspect::createConfigurationWidget() @@ -254,7 +255,7 @@ void RunConfiguration::ctor() } /*! - \brief Used to find out whether a runconfiguration is enabled + Checks whether a run configuration is enabled. */ bool RunConfiguration::isEnabled() const @@ -331,13 +332,14 @@ bool RunConfiguration::fromMap(const QVariantMap &map) \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 - of subclasses or the need to add all options to the base class. + Aspects are a mechanism to add RunControl-specific options to a run + configuration without subclassing the run configuration for every addition. + This prevents a combinatorial explosion of subclasses and eliminates + the need to add all options to the base class. */ /*! - \brief Return extra aspects. + Returns extra aspects. \sa ProjectExplorer::IRunConfigurationAspect */ @@ -369,23 +371,28 @@ Utils::OutputFormatter *RunConfiguration::createOutputFormatter() const settings. The run configuration factory is used for restoring run configurations from - settings. And used to create new runconfigurations in the "Run Settings" Dialog. - For the first case, bool canRestore(Target *parent, const QString &id) and - RunConfiguration* create(Target *parent, const QString &id) are used. - For the second type, the functions QStringList availableCreationIds(Target *parent) and - QString displayNameForType(const QString&) are used to generate a list of creatable - RunConfigurations, and create(..) is used to create it. + settings and for creating new run configurations in the \gui {Run Settings} + dialog. + To restore run configurations, use the + \c {bool canRestore(Target *parent, const QString &id)} + and \c {RunConfiguration* create(Target *parent, const QString &id)} + functions. + + To generate a list of creatable run configurations, use the + \c {QStringList availableCreationIds(Target *parent)} and + \c {QString displayNameForType(const QString&)} functions. To create a + run configuration, use \c create(). */ /*! \fn QStringList ProjectExplorer::IRunConfigurationFactory::availableCreationIds(Target *parent) const - \brief Used to show the list of possible additons to a target, returns a list of types. + Shows the list of possible additions to a target. Returns a list of types. */ /*! \fn QString ProjectExplorer::IRunConfigurationFactory::displayNameForId(const Core::Id id) const - \brief Used to translate the types to names to display to the user. + Translates the types to names to display to the user. */ IRunConfigurationFactory::IRunConfigurationFactory(QObject *parent) : @@ -462,20 +469,13 @@ QList<IRunConfigurationFactory *> IRunConfigurationFactory::find(Target *parent) */ /*! - \fn IRunConfigurationAspect *ProjectExplorer::IRunControlFactory::createRunConfigurationAspect(RunConfiguration *rc) - \brief Return an IRunConfigurationAspect to carry options for RunControls this factory can create. - - If no extra options are required it is allowed to return null like the default implementation does. - This is intended to be called from the RunConfiguration constructor, so passing a RunConfiguration - pointer makes no sense because that object is under construction at the time. -*/ - -/*! \fn RunConfigWidget *ProjectExplorer::IRunConfigurationAspect::createConfigurationWidget() - \brief Return a widget used to configure this runner. Ownership is transferred to the caller. + Returns a widget used to configure this runner. Ownership is transferred to + the caller. - Return 0 if @p runConfiguration is not suitable for RunControls from this factory, or no user-accessible + Returns 0 if @p \a runConfiguration is not suitable for RunControls from this + factory, or no user-accessible configuration is required. */ @@ -488,6 +488,16 @@ IRunControlFactory::~IRunControlFactory() { } +/*! + Returns an IRunConfigurationAspect to carry options for RunControls this + factory can create. + + If no extra options are required, it is allowed to return null like the + default implementation does. This function is intended to be called from the + RunConfiguration constructor, so passing a RunConfiguration pointer makes + no sense because that object is under construction at the time. +*/ + IRunConfigurationAspect *IRunControlFactory::createRunConfigurationAspect(RunConfiguration *rc) { Q_UNUSED(rc); @@ -500,17 +510,11 @@ IRunConfigurationAspect *IRunControlFactory::createRunConfigurationAspect(RunCon */ /*! - \fn bool ProjectExplorer::RunControl::promptToStop(bool *optionalPrompt = 0) const - - \brief Prompt to stop. If 'optionalPrompt' is passed, a "Do not ask again"- - checkbox will show and the result will be returned in '*optionalPrompt'. -*/ - -/*! \fn QIcon ProjectExplorer::RunControl::icon() const - \brief Eeturns the icon to be shown in the Outputwindow. + Returns the icon to be shown in the Outputwindow. - TODO the icon differs currently only per "mode", so this is more flexible then it needs to be. + TODO the icon differs currently only per "mode", so this is more flexible + than it needs to be. */ RunControl::RunControl(RunConfiguration *runConfiguration, RunMode mode) @@ -570,6 +574,11 @@ void RunControl::setApplicationProcessHandle(const ProcessHandle &handle) } } +/*! + Prompts to stop. If \a optionalPrompt is passed, a \gui {Do not ask again} + checkbox is displayed and the result is returned in \a *optionalPrompt. +*/ + bool RunControl::promptToStop(bool *optionalPrompt) const { QTC_ASSERT(isRunning(), return true); @@ -585,7 +594,8 @@ bool RunControl::promptToStop(bool *optionalPrompt) const } /*! - \brief Utility to prompt to terminate application with checkable box. + Prompts to terminate the application with the \gui {Do not ask again} + checkbox. */ bool RunControl::showPromptToStopDialog(const QString &title, diff --git a/src/plugins/projectexplorer/runconfigurationmodel.cpp b/src/plugins/projectexplorer/runconfigurationmodel.cpp index e9d19e7f36..ad95a37c41 100644 --- a/src/plugins/projectexplorer/runconfigurationmodel.cpp +++ b/src/plugins/projectexplorer/runconfigurationmodel.cpp @@ -39,8 +39,8 @@ using namespace ProjectExplorer; \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 + To be used in the dropdown lists of comboboxes. + Automatically adjusts itself to added and removed run configurations. */ class RunConfigurationComparer diff --git a/src/plugins/projectexplorer/session.cpp b/src/plugins/projectexplorer/session.cpp index 2d3f7d3b7e..eb9c60378a 100644 --- a/src/plugins/projectexplorer/session.cpp +++ b/src/plugins/projectexplorer/session.cpp @@ -67,8 +67,8 @@ namespace ProjectExplorer { \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 - public interface just wrap around functions which do the actual work + The implementation suffers from that all the functions from the + public interface just wrap around functions which do the actual work. This could be improved. */ @@ -648,7 +648,7 @@ void SessionManager::removeProjects(QList<Project *> remove) } /*! - \brief Let other plugins store persistent values within the session file. + Lets other plugins store persistent values within the session file. */ void SessionManager::setValue(const QString &name, const QVariant &value) @@ -691,7 +691,7 @@ FileName SessionManager::sessionNameToFileName(const QString &session) } /*! - \brief Just creates a new session (Does not actually create the file). + Creates \a session, but does not actually create the file. */ bool SessionManager::createSession(const QString &session) @@ -725,7 +725,7 @@ bool SessionManager::confirmSessionDelete(const QString &session) } /*! - \brief Deletes session name from session list and file from disk. + Deletes \a session name from session list and the file from disk. */ bool SessionManager::deleteSession(const QString &session) { @@ -830,7 +830,7 @@ void SessionManagerPrivate::restoreEditors(const PersistentSettingsReader &reade } /*! - \brief Loads a session, takes a session name (not filename). + Loads a session, takes a session name (not filename). */ void SessionManagerPrivate::restoreProjects(const QStringList &fileList) { diff --git a/src/plugins/projectexplorer/toolchain.cpp b/src/plugins/projectexplorer/toolchain.cpp index d7d7b14454..d6b3d2d919 100644 --- a/src/plugins/projectexplorer/toolchain.cpp +++ b/src/plugins/projectexplorer/toolchain.cpp @@ -154,9 +154,9 @@ bool ToolChain::operator == (const ToolChain &tc) const } /*! - \brief Used by the toolchainmanager to save user-generated tool chains. + Used by the tool chain manager to save user-generated tool chains. - Make sure to call this method when deriving! + Make sure to call this method when deriving. */ QVariantMap ToolChain::toMap() const @@ -183,9 +183,9 @@ void ToolChain::setDetection(ToolChain::Detection de) } /*! - \brief Used by the toolchainmanager to load user-generated tool chains. + Used by the tool chain manager to load user-generated tool chains. - Make sure to call this method when deriving! + Make sure to call this method when deriving. */ bool ToolChain::fromMap(const QVariantMap &data) @@ -200,7 +200,7 @@ bool ToolChain::fromMap(const QVariantMap &data) } /*! - \brief Used by the toolchainkitinformation to validate the kit. + Used by the tool chain kit information to validate the kit. */ QList<Task> ToolChain::validateKit(const Kit *) const @@ -210,22 +210,25 @@ QList<Task> ToolChain::validateKit(const Kit *) const /*! \class ProjectExplorer::ToolChainFactory - \brief Creates toolchains from settings or autodetects them. + \brief The ToolChainFactory class creates tool chains from settings or + autodetects them. */ /*! \fn QString ProjectExplorer::ToolChainFactory::displayName() const = 0 - \brief Name used to display the name of the tool chain that will be created. + Contains the name used to display the name of the tool chain that will be + created. */ /*! \fn QStringList ProjectExplorer::ToolChain::clangParserFlags(const QStringList &cxxflags) const = 0 - \brief Converts toolchain-specific flags to list flags that tunes libclang parser + Converts tool chain specific flags to list flags that tune the libclang + parser. */ /*! \fn bool ProjectExplorer::ToolChainFactory::canRestore(const QVariantMap &data) - \brief Used by the ToolChainManager to restore user-generated tool chains. + Used by the tool chain manager to restore user-generated tool chains. */ QList<ToolChain *> ToolChainFactory::autoDetect() diff --git a/src/plugins/projectexplorer/windebuginterface.cpp b/src/plugins/projectexplorer/windebuginterface.cpp index c8b206b643..665fbb9814 100644 --- a/src/plugins/projectexplorer/windebuginterface.cpp +++ b/src/plugins/projectexplorer/windebuginterface.cpp @@ -41,7 +41,7 @@ Emits output by process id. - OutputDebugString puts its data into a shared memory segment named + The \c OutputDebugString() function puts its data into a shared memory segment named \c DBWIN_BUFFER which can be accessed via file mapping. */ diff --git a/src/plugins/qmldesigner/designercore/exceptions/exception.cpp b/src/plugins/qmldesigner/designercore/exceptions/exception.cpp index 4c22033961..1076f18174 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/exception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/exception.cpp @@ -118,9 +118,7 @@ Exception::~Exception() } /*! -\brief Returns the unmangled backtrace of this exception - -\returns the backtrace as a string + Returns the unmangled backtrace of this exception as a string. */ QString Exception::backTrace() const { @@ -128,9 +126,7 @@ QString Exception::backTrace() const } /*! -\brief Returns the optional description of this exception - -\returns the description as string + Returns the optional description of this exception as a string. */ QString Exception::description() const { @@ -138,9 +134,7 @@ QString Exception::description() const } /*! -\brief Returns the line number where this exception was thrown - -\returns the line number as integer + Returns the line number where this exception was thrown as an integer. */ int Exception::line() const { @@ -148,9 +142,7 @@ int Exception::line() const } /*! -\brief Returns the function name where this exception was thrown - -\returns the function name as string + Returns the function name where this exception was thrown as a string. */ QString Exception::function() const { @@ -158,9 +150,7 @@ QString Exception::function() const } /*! -\brief Returns the file name where this exception was thrown - -\returns the file name as string + Returns the file name where this exception was thrown as a string. */ QString Exception::file() const { @@ -184,8 +174,6 @@ QDebug operator<<(QDebug debug, const Exception &exception) /*! \fn QString Exception::type() const -\brief Returns the type of this exception - -\returns the type as a string +Returns the type of this exception as a string. */ } diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp index e96420e83d..6ce15aa9e3 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp @@ -62,9 +62,7 @@ QString InvalidArgumentException::description() const } /*! -\brief Returns the type of this exception - -\returns the type as a string + Returns the type of the exception as a string. */ QString InvalidArgumentException::type() const { @@ -72,9 +70,7 @@ QString InvalidArgumentException::type() const } /*! -\brief Returns the argument of this exception - -\returns the argument as a string + Returns the argument of the exception as a string. */ QString InvalidArgumentException::argument() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp index 7053a3c6e5..9d207b91d8 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp @@ -51,9 +51,7 @@ InvalidMetaInfoException::InvalidMetaInfoException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string + Returns the type of this exception as a string. */ QString InvalidMetaInfoException::type() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp index 2a85a71b28..058ff197f3 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp @@ -51,9 +51,7 @@ InvalidModelNodeException::InvalidModelNodeException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string + Returns the type of this exception as a string. */ QString InvalidModelNodeException::type() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp index 1930b377f4..114379472f 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp @@ -52,9 +52,7 @@ InvalidModelStateException::InvalidModelStateException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string + Returns the type of the exception as a string. */ QString InvalidModelStateException::type() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp index 51e61cc6f6..3f33734c63 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp @@ -51,9 +51,7 @@ InvalidPropertyException::InvalidPropertyException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string + Returns the type of this exception as a string. */ QString InvalidPropertyException::type() const { @@ -61,9 +59,7 @@ QString InvalidPropertyException::type() const } /*! -\brief Returns the argument of the property of this exception - -\returns the argument as a string + Returns the argument of the property of this exception as a string. */ QString InvalidPropertyException::argument() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp index af899afe29..acdecda042 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp @@ -52,9 +52,7 @@ InvalidQmlSourceException::InvalidQmlSourceException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string + Returns the type of the exception as a string. */ QString InvalidQmlSourceException::type() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp index 97fd0474ee..3ba27caa90 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp @@ -50,9 +50,7 @@ InvalidReparentingException::InvalidReparentingException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string +Returns the type of this exception as a string. */ QString InvalidReparentingException::type() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp index 057db79dd5..c0fa1ee9b9 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp @@ -41,6 +41,7 @@ namespace QmlDesigner { /*! Constructs an exception. \a line uses the __LINE__ macro, \a function uses the __FUNCTION__ or the Q_FUNC_INFO macro, and \a file uses + the __FILE__ macro. */ InvalidSlideIndexException::InvalidSlideIndexException(int line, const QString &function, @@ -50,9 +51,7 @@ InvalidSlideIndexException::InvalidSlideIndexException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string + Returns the type of the exception as a string. */ QString InvalidSlideIndexException::type() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp index 01ec9752a0..3d7f935d0c 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp @@ -50,9 +50,7 @@ ModificationGroupException::ModificationGroupException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string + Returns the type of the exception as a string. */ QString ModificationGroupException::type() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp index 105d93c1cc..436ba7943c 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp @@ -51,9 +51,7 @@ RemoveBaseStateException::RemoveBaseStateException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string +Returns the type of this exception as a string. */ QString RemoveBaseStateException::type() const { diff --git a/src/plugins/qmldesigner/designercore/filemanager/firstdefinitionfinder.cpp b/src/plugins/qmldesigner/designercore/filemanager/firstdefinitionfinder.cpp index b1a7834b9a..d35b1d5f93 100644 --- a/src/plugins/qmldesigner/designercore/filemanager/firstdefinitionfinder.cpp +++ b/src/plugins/qmldesigner/designercore/filemanager/firstdefinitionfinder.cpp @@ -53,11 +53,8 @@ FirstDefinitionFinder::FirstDefinitionFinder(const QString &text): } /*! - \brief Finds the first object definition inside the object given by offset - - - \arg the offset of the object to search in - \return the offset of the first object definition + Finds the first object definition inside the object specified by \a offset. + Returns the offset of the first object definition. */ qint32 FirstDefinitionFinder::operator()(quint32 offset) { diff --git a/src/plugins/qmldesigner/designercore/instances/nodeinstanceview.cpp b/src/plugins/qmldesigner/designercore/instances/nodeinstanceview.cpp index 21d4b2d333..97f5feb73d 100644 --- a/src/plugins/qmldesigner/designercore/instances/nodeinstanceview.cpp +++ b/src/plugins/qmldesigner/designercore/instances/nodeinstanceview.cpp @@ -82,11 +82,11 @@ enum { \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. -For this purpose this view can be rendered offscreen. + This view is used to instantiate the model nodes. Many abstract views hold a + node instance view to get values from the node instances. + For this purpose, this view can be rendered offscreen. -\see NodeInstance ModelNode + \sa NodeInstance, ModelNode */ namespace QmlDesigner { @@ -97,8 +97,7 @@ namespace QmlDesigner { The class will be rendered offscreen if not set otherwise. - -\see ~NodeInstanceView setRenderOffScreen + \sa ~NodeInstanceView, setRenderOffScreen() */ NodeInstanceView::NodeInstanceView(QObject *parent, NodeInstanceServerInterface::RunModus runModus) : AbstractView(parent), @@ -109,8 +108,8 @@ NodeInstanceView::NodeInstanceView(QObject *parent, NodeInstanceServerInterface: } -/*! \brief Destructor - +/*! + Destructs a node instance view object. */ NodeInstanceView::~NodeInstanceView() { @@ -118,15 +117,7 @@ NodeInstanceView::~NodeInstanceView() delete nodeInstanceServer(); } -/*! \name Overloaded Notifiers - * This methodes notify the view that something has happen in the model - */ //\{ -/*! \brief Notifing the view that it was attached to a model. - - For every ModelNode in the model a NodeInstance will be created. -\param model Model to which the view is attached -*/ bool isSkippedRootNode(const ModelNode &node) { @@ -149,6 +140,11 @@ bool isSkippedNode(const ModelNode &node) return false; } +/*! + Notifies the view that it was attached to \a model. For every model node in + the model, a NodeInstance will be created. +*/ + void NodeInstanceView::modelAttached(Model *model) { AbstractView::modelAttached(model); @@ -223,8 +219,7 @@ void NodeInstanceView::nodeCreated(const ModelNode &createdNode) nodeInstanceServer()->completeComponent(createComponentCompleteCommand(QList<NodeInstance>() << instance)); } -/*! \brief Notifing the view that a node was created. -\param removedNode +/*! Notifies the view that \a removedNode will be removed. */ void NodeInstanceView::nodeAboutToBeRemoved(const ModelNode &removedNode) { @@ -358,31 +353,27 @@ void NodeInstanceView::signalHandlerPropertiesChanged(const QVector<SignalHandle { } -/*! \brief Notifing the view that a AbstractProperty value was changed to a ModelNode. +/*! + Notifies the view that abstract property values specified by \a propertyList + were changed for a model node. - The property will be set for the NodeInstance. + The property will be set for the node instance. -\param state ModelNode to which the Property belongs -\param property AbstractProperty which was changed -\param newValue New Value of the property -\param oldValue Old Value of the property -\see AbstractProperty NodeInstance ModelNode + \sa AbstractProperty, NodeInstance, ModelNode */ void NodeInstanceView::variantPropertiesChanged(const QList<VariantProperty>& propertyList, PropertyChangeFlags /*propertyChange*/) { nodeInstanceServer()->changePropertyValues(createChangeValueCommand(propertyList)); } -/*! \brief Notifing the view that a ModelNode has a new Parent. - - Note that also the ModelNode::childNodes() list was changed. The - NodeInstance tree will be changed to reflect the ModelNode tree change. +/*! + Notifies the view that the property parent of the model node \a node has + changed from \a oldPropertyParent to \a newPropertyParent. -\param node ModelNode which parent was changed. -\param oldParent Old parent of the node. -\param newParent New parent of the node. + \note Also the \c {ModelNode::childNodes()} list was changed. The + Node instance tree will be changed to reflect the model node tree change. -\see NodeInstance ModelNode + \sa NodeInstance, ModelNode */ void NodeInstanceView::nodeReparented(const ModelNode &node, const NodeAbstractProperty &newPropertyParent, const NodeAbstractProperty &oldPropertyParent, AbstractView::PropertyChangeFlags /*propertyChange*/) @@ -431,14 +422,13 @@ void NodeInstanceView::nodeOrderChanged(const NodeListProperty & listProperty, nodeInstanceServer()->reparentInstances(ReparentInstancesCommand(containerList)); } -/*! \brief Notifing the view that the selection has been changed. +/*! + Notifies the view that the list of selected model nodes has changed to + \a selectedNodeList from \a lastSelectedNodeList. Do nothing. -\param selectedNodeList List of ModelNode which has been selected -\param lastSelectedNodeList List of ModelNode which was selected - -\see ModelNode NodeInstance + \sa ModelNode, NodeInstance */ void NodeInstanceView::selectedNodesChanged(const QList<ModelNode> &/*selectedNodeList*/, const QList<ModelNode> &/*lastSelectedNodeList*/) @@ -558,9 +548,10 @@ void NodeInstanceView::removeAllInstanceNodeRelationships() m_nodeInstanceHash.clear(); } -/*! \brief Returns a List of all NodeInstances +/*! + Returns a list of all node instances. -\see NodeInstance + \sa NodeInstance */ QList<NodeInstance> NodeInstanceView::instances() const @@ -568,13 +559,13 @@ QList<NodeInstance> NodeInstanceView::instances() const return m_nodeInstanceHash.values(); } -/*! \brief Returns the NodeInstance for this ModelNode +/*! + Returns the node instance for \a node, which must be valid. - Returns a invalid NodeInstance if no NodeInstance for this ModelNode exists. + Returns an invalid node instance if no node instance for this model node + exists. -\param node ModelNode must be valid. -\returns NodeStance for ModelNode. -\see NodeInstance + \sa NodeInstance */ NodeInstance NodeInstanceView::instanceForModelNode(const ModelNode &node) const { @@ -606,20 +597,20 @@ bool NodeInstanceView::hasInstanceForId(qint32 id) } -/*! \brief Returns the root NodeInstance of this view. - +/*! + Returns the root node instance of this view. -\returns Root NodeIntance for this view. -\see NodeInstance + \sa NodeInstance */ NodeInstance NodeInstanceView::rootNodeInstance() const { return m_rootNodeInstance; } -/*! \brief Returns the view NodeInstance of this view. +/*! + Returns the \a instance of this view. - This can be the root NodeInstance if it is specified in the qml file. + This can be the root node instance if it is specified in the QML file. \code QGraphicsView { QGraphicsScene { @@ -628,19 +619,18 @@ NodeInstance NodeInstanceView::rootNodeInstance() const } \endcode - If there is node view in the qml file: + If there is node view in the QML file: \code Item {} \endcode - Than there will be a new NodeInstance for this QGraphicsView - generated which is not the root instance of this NodeInstanceView. + Then a new node instance for this QGraphicsView is + generated which is not the root instance of this node instance view. - This is the way to get this QGraphicsView NodeInstance. + This is the way to get this QGraphicsView node instance. -\returns Root NodeIntance for this view. -\see NodeInstance + \sa NodeInstance */ diff --git a/src/plugins/qmldesigner/designercore/metainfo/metainfo.cpp b/src/plugins/qmldesigner/designercore/metainfo/metainfo.cpp index 96c0f3bba4..cefc0b9987 100644 --- a/src/plugins/qmldesigner/designercore/metainfo/metainfo.cpp +++ b/src/plugins/qmldesigner/designercore/metainfo/metainfo.cpp @@ -125,7 +125,7 @@ properties. */ /*! - \brief Constructs a copy of the given meta info. + Constructs a copy of \a metaInfo. */ MetaInfo::MetaInfo(const MetaInfo &metaInfo) : m_p(metaInfo.m_p) @@ -133,12 +133,12 @@ MetaInfo::MetaInfo(const MetaInfo &metaInfo) : } /*! - \brief Creates a meta information object with just the qml types registered statically. - You almost always want to use Model::metaInfo() instead! + Creates a meta information object with just the QML types registered statically. + You almost always want to use Model::metaInfo() instead. You almost certainly want to access the meta information for the model. - \see Model::metaInfo() + \sa Model::metaInfo() */ MetaInfo::MetaInfo() : m_p(new MetaInfoPrivate(this)) @@ -150,7 +150,8 @@ MetaInfo::~MetaInfo() } /*! - \brief Assigns other to this meta information and returns a reference to this meta information. + Assigns \a other to this meta information and returns a reference to this + meta information. */ MetaInfo& MetaInfo::operator=(const MetaInfo &other) { @@ -164,11 +165,11 @@ ItemLibraryInfo *MetaInfo::itemLibraryInfo() const } /*! - \brief Access to the global meta information object. + Accesses the global meta information object. You almost always want to use Model::metaInfo() instead. - Internally all meta information objects share this "global" object - where static qml type information is stored. + Internally, all meta information objects share this \e global object + where static QML type information is stored. */ MetaInfo MetaInfo::global() { @@ -180,7 +181,7 @@ MetaInfo MetaInfo::global() } /*! - \brief Clears the global meta information object. + Clears the global meta information object. This method should be called once on application shutdown to free static data structures. */ diff --git a/src/plugins/qmldesigner/designercore/model/abstractproperty.cpp b/src/plugins/qmldesigner/designercore/model/abstractproperty.cpp index 67cc807d8d..267d01d716 100644 --- a/src/plugins/qmldesigner/designercore/model/abstractproperty.cpp +++ b/src/plugins/qmldesigner/designercore/model/abstractproperty.cpp @@ -120,10 +120,9 @@ AbstractView *AbstractProperty::view() const } /*! - \brief AbstractProperty is a value holder for a property - \return the value of the property + Holds a value for a property. Returns the value of the property. - The QVariant is null if the property doesn't exists. + The QVariant is null if the property does not exist. */ PropertyName AbstractProperty::name() const { @@ -135,13 +134,13 @@ PropertyName AbstractProperty::name() const } /*! - \brief Checks if the property is valid. + Checks if the property is valid. - A prooperty is valid if the belonging ModelNode + A property is valid if the belonging model node is valid. This function is not overloaded for subclasses. - \return the property is valid for true return value + Returns whether the property is valid for the \c true return value. */ bool AbstractProperty::isValid() const { @@ -206,8 +205,7 @@ bool AbstractProperty::isValid() const //} /*! - \brief returns the ModelNode to which the property belongs - \return node to which the property belongs + Returns the model node to which the property belongs. */ ModelNode AbstractProperty::parentModelNode() const { @@ -215,15 +213,14 @@ ModelNode AbstractProperty::parentModelNode() const } /*! -\brief returns the QmlObjectNode to which the property belongs -\return node to which the property belongs + Returns the QmlObjectNode to which the property belongs. */ QmlObjectNode AbstractProperty::parentQmlObjectNode() const { return QmlObjectNode(parentModelNode()); } /*! - \brief returns whether the property is the default property for the model node. + Returns whether the property is the default property for the model node. */ bool AbstractProperty::isDefaultProperty() const { @@ -404,7 +401,8 @@ TypeName AbstractProperty::dynamicTypeName() const } /*! - \brief Returns if the the two property handles reference the same property in the same node + Returns whether \a property1 and \a property2 reference the same property in + the same node. */ bool operator ==(const AbstractProperty &property1, const AbstractProperty &property2) { @@ -414,7 +412,8 @@ bool operator ==(const AbstractProperty &property1, const AbstractProperty &prop } /*! - \brief Returns if the the two property handles do not reference the same property in the same node + Returns whether \a property1 and \a property2 do not reference the same + property in the same node. */ bool operator !=(const AbstractProperty &property1, const AbstractProperty &property2) { diff --git a/src/plugins/qmldesigner/designercore/model/abstractview.cpp b/src/plugins/qmldesigner/designercore/model/abstractview.cpp index c7569ea21b..ccfa498dd6 100644 --- a/src/plugins/qmldesigner/designercore/model/abstractview.cpp +++ b/src/plugins/qmldesigner/designercore/model/abstractview.cpp @@ -44,7 +44,7 @@ namespace QmlDesigner { \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 +\sa QmlDesigner::WidgetQueryView(), QmlDesigner::NodeInstanceView() */ AbstractView::~AbstractView() @@ -54,8 +54,10 @@ AbstractView::~AbstractView() } /*! -\brief sets the view of the model. this is handled automatically by AbstractView::modelAttached. -\param model new Model + Sets the view of a new \a model. This is handled automatically by + AbstractView::modelAttached(). + + \sa AbstractView::modelAttached() */ void AbstractView::setModel(Model *model) { @@ -86,9 +88,8 @@ ModelNode AbstractView::createModelNode(const TypeName &typeName, } -/*! \brief returns the root model node -\return constant root model node - +/*! + Returns the constant root model node. */ const ModelNode AbstractView::rootModelNode() const @@ -98,9 +99,8 @@ const ModelNode AbstractView::rootModelNode() const } -/*! \brief returns the root model node -\return root model node - +/*! + Returns the root model node. */ ModelNode AbstractView::rootModelNode() @@ -110,7 +110,7 @@ ModelNode AbstractView::rootModelNode() } /*! -\brief sets the reference to model to a null pointer + Sets the reference to a model to a null pointer. */ void AbstractView::removeModel() @@ -138,13 +138,7 @@ WidgetInfo AbstractView::createWidgetInfo(QWidget *widget, } /*! -\name Model related functions -\{ -*/ - -/*! -\brief returns the model -\return the model of the view + Returns the model of the view. */ Model* AbstractView::model() const { @@ -157,10 +151,9 @@ bool AbstractView::isAttached() const } /*! -\brief is called if a view is being attached to a model -\param model which is being attached +Called if a view is being attached to \a model. The default implementation is setting the reference of the model to the view. -\see Model::attachView +\sa Model::attachView() */ void AbstractView::modelAttached(Model *model) { @@ -168,96 +161,73 @@ void AbstractView::modelAttached(Model *model) } /*! -\brief is called before a view is being detached from a model -\param model which is being detached +Called before a view is detached from \a model. -This is not called if Model::detachViewWithOutNotification is used! The default implementation +This function is not called if Model::detachViewWithOutNotification is used. +The default implementation is removing the reference to the model from the view. -\see Model::detachView +\sa Model::detachView() */ void AbstractView::modelAboutToBeDetached(Model *) { removeModel(); } -//\} - - /*! -\name Property related functions -\{ - */ + \enum QmlDesigner::AbstractView::PropertyChangeFlag -/*! -\fn void QmlDesigner::AbstractView::propertyAdded(const ModelNode &, const AbstractProperty &) -\brief node notifies about that this property is added -\param node node to which the property is added -\param property added property -*/ + Notifies about changes in the abstract properties of a node: + \value NoAdditionalChanges + No changes were made. -/*! -\fn void AbstractView::propertyValueChanged(const ModelNode &, const AbstractProperty& , const QVariant& , const QVariant& ) -\brief this notifies about that the value of this proeprty will be changes -\param node node of the property -\param property changed property -\param newValue the variant of the new value -\param oldValue the variant of the old value + \value PropertiesAdded + Some properties were added. + + \value EmptyPropertiesRemoved + Empty properties were removed. */ -//\} -/*! -\name Node related functions -\{ - */ +// Node related functions /*! -\fn void AbstractView::nodeCreated(const ModelNode &) -\brief this function is called if a new node was created -\param createdNode created node +\fn void AbstractView::nodeCreated(const ModelNode &createdNode) +Called when the new node \a createdNode is created. */ - /*! -\fn AbstractView::fileUrlChanged(const QUrl &oldBaseUrl, const QUrl &newBaseUrl) -\brief Called when the file url (e.g. needed to to resolve relative paths against) has changed -\param oldBaseUrl old search path -\param newBaseUrl new search path +Called when the file URL (that is needed to resolve relative paths against, +for example) is changed form \a oldUrl to \a newUrl. */ void AbstractView::fileUrlChanged(const QUrl &/*oldUrl*/, const QUrl &/*newUrl*/) { } /*! -\fn void AbstractView::nodeAboutToBeRemoved(const ModelNode &) -\brief this is called if a node will be removed -\param removedNode to be removed node +\fn void AbstractView::nodeAboutToBeRemoved(const ModelNode &removedNode) +Called when the node specified by \a removedNode will be removed. */ /*! -\brief this is called after a propererty was removed -\param propertyList removed property list +Called when the properties specified by \a propertyList are removed. */ void AbstractView::propertiesRemoved(const QList<AbstractProperty>& /*propertyList*/) { } /*! -\fn void AbstractView::nodeReparented(const ModelNode &, const ModelNode &, const ModelNode &) -\brief this is called if a node was reparented -\param node the parent for this node will be changed -\param oldParent old parent of the node -\param newParent new parent of the node +\fn void nodeReparented(const ModelNode &node, const NodeAbstractProperty &newPropertyParent, const NodeAbstractProperty &oldPropertyParent, AbstractView::PropertyChangeFlags propertyChange) +Called when the parent of \a node will be changed from \a oldPropertyParent to +\a newPropertyParent. */ /*! -\fn void QmlDesigner::AbstractView::selectedNodesChanged(const QList< ModelNode > &, const QList< ModelNode > &) -\brief this function is called if the selection was changed -\param selectedNodeList the new selection list -\param lastSelectedNodeList the old selection list +\fn void QmlDesigner::AbstractView::selectedNodesChanged(const QList<ModelNode> &selectedNodeList, + const QList<ModelNode> &lastSelectedNodeList) +Called when the selection is changed from \a lastSelectedNodeList to +\a selectedNodeList. */ -//\} void AbstractView::auxiliaryDataChanged(const ModelNode &/*node*/, const PropertyName &/*name*/, const QVariant &/*data*/) { @@ -292,8 +262,8 @@ QList<Internal::InternalNode::Pointer> toInternalNodeList(const QList<ModelNode> } /*! -\brief set this list nodes to the actual selected nodes -\param focusNodeList list the selected nodes + Sets the list of nodes to the actual selected nodes specified by + \a selectedNodeList. */ void AbstractView::setSelectedModelNodes(const QList<ModelNode> &selectedNodeList) { @@ -306,7 +276,7 @@ void AbstractView::setSelectedModelNode(const ModelNode &modelNode) } /*! -\brief clears the selection + Clears the selection. */ void AbstractView::clearSelectedModelNodes() { @@ -324,8 +294,8 @@ bool AbstractView::hasSingleSelectedModelNode() const } /*! -\brief set this list nodes to the actual selected nodes -\return list the selected nodes + Sets the list of nodes to the actual selected nodes. Returns a list of the + selected nodes. */ QList<ModelNode> AbstractView::selectedModelNodes() const { @@ -349,8 +319,7 @@ ModelNode AbstractView::singleSelectedModelNode() const } /*! -\brief adds a node to the selection list -\param node to be added to the selection list + Adds \a node to the selection list. */ void AbstractView::selectModelNode(const ModelNode &node) { @@ -358,8 +327,7 @@ void AbstractView::selectModelNode(const ModelNode &node) } /*! -\brief removes a node from the selection list -\param node to be removed from the selection list + Removes \a node from the selection list. */ void AbstractView::deselectModelNode(const ModelNode &node) { diff --git a/src/plugins/qmldesigner/designercore/model/nodeabstractproperty.cpp b/src/plugins/qmldesigner/designercore/model/nodeabstractproperty.cpp index b243571237..4dc5fc6e7c 100644 --- a/src/plugins/qmldesigner/designercore/model/nodeabstractproperty.cpp +++ b/src/plugins/qmldesigner/designercore/model/nodeabstractproperty.cpp @@ -136,7 +136,8 @@ QList<ModelNode> NodeAbstractProperty::allSubNodes() } /*! - \brief Returns if the the two property handles reference the same property in the same node + Returns whether property handles \a property1 and \a property2 reference + the same property in the same node. */ bool operator ==(const NodeAbstractProperty &property1, const NodeAbstractProperty &property2) { @@ -144,7 +145,8 @@ bool operator ==(const NodeAbstractProperty &property1, const NodeAbstractProper } /*! - \brief Returns if the the two property handles do not reference the same property in the same node + Returns whether the property handles \a property1 and \a property2 do not + reference the same property in the same node. */ bool operator !=(const NodeAbstractProperty &property1, const NodeAbstractProperty &property2) { diff --git a/src/plugins/qmldesigner/designercore/model/qmlobjectnode.cpp b/src/plugins/qmldesigner/designercore/model/qmlobjectnode.cpp index 1746e956c7..83379fad59 100644 --- a/src/plugins/qmldesigner/designercore/model/qmlobjectnode.cpp +++ b/src/plugins/qmldesigner/designercore/model/qmlobjectnode.cpp @@ -88,11 +88,10 @@ bool QmlObjectNode::isRootModelNode() const } -/*! \brief returns the value of a property based on an actual instance -The return value is not the value in the model, but the value of a real -instanciated instance of this object. -\return the value of this property based on the instance - +/*! + Returns the value of the property specified by \name that is based on an + actual instance. The return value is not the value in the model, but the + value of a real instantiated instance of this object. */ QVariant QmlObjectNode::instanceValue(const PropertyName &name) const { @@ -228,10 +227,8 @@ QString QmlObjectNode::expression(const PropertyName &name) const return propertyChanges.modelNode().bindingProperty(name).expression(); } -/*! \brief returns if ObjectNode is the BaseState - -\return true if the ObjectNode is in the BaseState - +/*! + Returns \c true if the ObjectNode is in the BaseState. */ bool QmlObjectNode::isInBaseState() const { @@ -271,10 +268,10 @@ static void removeStateOperationsForChildren(const QmlObjectNode &node) } -/*! \brief Deletes this objects ModeNode and its dependencies from the model -Every thing that belongs to this Object, the ModelNode and ChangeOperations -are deleted from the model. - +/*! + Deletes this object's node and its dependencies from the model. + Everything that belongs to this Object, the ModelNode, and ChangeOperations + is deleted from the model. */ void QmlObjectNode::destroy() { @@ -288,9 +285,8 @@ void QmlObjectNode::destroy() modelNode().destroy(); } -/*! \brief Returns a list of all states that are affecting this object. - -\return list of states affecting this object +/*! + Returns a list of states the affect this object. */ QList<QmlModelState> QmlObjectNode::allAffectingStates() const @@ -307,9 +303,8 @@ QList<QmlModelState> QmlObjectNode::allAffectingStates() const return returnList; } -/*! \brief Returns a list of all state operations that are affecting this object. - -\return list of state operations affecting this object +/*! + Returns a list of all state operations that affect this object. */ QList<QmlModelStateOperation> QmlObjectNode::allAffectingStatesOperations() const @@ -362,8 +357,9 @@ QList<QmlModelState> QmlObjectNode::allDefinedStates() const } -/*! \brief Removes a variant property of this object from the model - +/*! + Removes a variant property of the object specified by \a name from the + model. */ void QmlObjectNode::removeProperty(const PropertyName &name) diff --git a/src/plugins/qmldesigner/designercore/model/qmlstate.cpp b/src/plugins/qmldesigner/designercore/model/qmlstate.cpp index 16e963da33..b2bd156ef9 100644 --- a/src/plugins/qmldesigner/designercore/model/qmlstate.cpp +++ b/src/plugins/qmldesigner/designercore/model/qmlstate.cpp @@ -141,9 +141,9 @@ QList<QmlModelStateOperation> QmlModelState::stateOperations() const } -/*! \brief Add a ChangeSet for the specified ModelNode to this state - The new ChangeSet if only added if no ChangeSet for the ModelNode - does not exist, yet. +/*! + Adds a change set for \a node to this state, but only if it does not + already exist. */ void QmlModelState::addChangeSetIfNotExists(const ModelNode &node) @@ -181,9 +181,8 @@ void QmlModelState::removePropertyChanges(const ModelNode &node) -/*! \brief Returns if this state affects the specified ModelNode - -\return true if this state affects the specifigied ModelNode +/*! + Returns \c true if this state affects \a node. */ bool QmlModelState::affectsModelNode(const ModelNode &node) const { @@ -241,9 +240,8 @@ void QmlModelState::destroy() modelNode().destroy(); } -/*! \brief Returns if this state is the base state - -\return true if this state is the base state +/*! + Returns \c true if this state is the base state. */ bool QmlModelState::isBaseState() const diff --git a/src/plugins/texteditor/basetextdocument.cpp b/src/plugins/texteditor/basetextdocument.cpp index 732ab6a3ee..239041311c 100644 --- a/src/plugins/texteditor/basetextdocument.cpp +++ b/src/plugins/texteditor/basetextdocument.cpp @@ -204,10 +204,10 @@ ITextMarkable *BaseTextDocument::documentMarker() const } /*! - * \brief Saves the document to the specified file. - * \param errorString output parameter, contains error reason. - * \param autoSave signalise that this function was called by the automatic save routine. - * If autosave is true, the cursor will be restored and some signals suppressed + * Saves the document to the file specified by \a fileName. If errors occur, + * \a errorString contains their cause. + * \a autoSave returns whether this function was called by the automatic save routine. + * If \a autoSave is true, the cursor will be restored and some signals suppressed * and we do not clean up the text file (cleanWhitespace(), ensureFinalNewLine()). */ bool BaseTextDocument::save(QString *errorString, const QString &saveFileName, bool autoSave) diff --git a/src/plugins/texteditor/codeassist/iassistprovider.cpp b/src/plugins/texteditor/codeassist/iassistprovider.cpp index 12aca9f3ce..2dac112c7f 100644 --- a/src/plugins/texteditor/codeassist/iassistprovider.cpp +++ b/src/plugins/texteditor/codeassist/iassistprovider.cpp @@ -52,7 +52,7 @@ using namespace TextEditor; /*! \fn bool TextEditor::IAssistProvider::supportsEditor(const Core::Id &editorId) const - Returns whether this provider supports the editor which has the give \a editorId. + Returns whether this provider supports the editor which has the \a editorId. */ /*! diff --git a/src/plugins/texteditor/syntaxhighlighter.cpp b/src/plugins/texteditor/syntaxhighlighter.cpp index f2483f9e58..1cf9359c37 100644 --- a/src/plugins/texteditor/syntaxhighlighter.cpp +++ b/src/plugins/texteditor/syntaxhighlighter.cpp @@ -342,7 +342,7 @@ SyntaxHighlighter::SyntaxHighlighter(BaseTextDocument *parent) } /*! - Constructs a SyntaxHighlighter and installs it on \a parent 's + Constructs a SyntaxHighlighter and installs it on \a parent's QTextDocument. The specified QTextEdit also becomes the owner of the SyntaxHighlighter. */ @@ -354,7 +354,7 @@ SyntaxHighlighter::SyntaxHighlighter(QTextEdit *parent) } /*! - Destructor. Uninstalls this syntax highlighter from the text document. + Destructor that uninstalls this syntax highlighter from the text document. */ SyntaxHighlighter::~SyntaxHighlighter() { diff --git a/src/plugins/vcsbase/corelistener.cpp b/src/plugins/vcsbase/corelistener.cpp index 017d95b6f5..e1252e7975 100644 --- a/src/plugins/vcsbase/corelistener.cpp +++ b/src/plugins/vcsbase/corelistener.cpp @@ -35,7 +35,7 @@ \brief The CoreListener class catches the closing of a submit editor. - Catch the closing of a submit editor to trigger the submit. + Catches the closing of a submit editor to trigger the submit. One instance of this class exists, connected to the instances of VcsBasePlugin, which dispatch if the editor kind matches theirs (which is why the approach of passing the bool result was chosen). diff --git a/src/plugins/vcsbase/submitfieldwidget.cpp b/src/plugins/vcsbase/submitfieldwidget.cpp index a0df616cf0..4dd0052198 100644 --- a/src/plugins/vcsbase/submitfieldwidget.cpp +++ b/src/plugins/vcsbase/submitfieldwidget.cpp @@ -57,10 +57,10 @@ static void inline setComboBlocked(QComboBox *cb, int index) fields like "reviewed-by:", "signed-off-by:". - It displays them in a vertical row of combo/line edit fields + The widget displays the fields in a vertical row of combo boxes or line edit fields that is modeled after the target address controls of mail clients. - When choosing a different field in the combo, a new row is opened if text - has been entered for the current field. Optionally, a "Browse..." button and + When choosing a different field in the combo box, a new row is opened if text + has been entered for the current field. Optionally, a \gui Browse button and completer can be added. */ diff --git a/src/plugins/vcsbase/submitfilemodel.cpp b/src/plugins/vcsbase/submitfilemodel.cpp index 895f8635b2..933fcc59f2 100644 --- a/src/plugins/vcsbase/submitfilemodel.cpp +++ b/src/plugins/vcsbase/submitfilemodel.cpp @@ -163,7 +163,7 @@ unsigned int SubmitFileModel::filterFiles(const QStringList &filter) /*! Updates user selections from \a source model. * - * Assumption: Both model are sorted with the same order, and there + * Assumes that both models are sorted with the same order, and there * are no duplicate entries. */ void SubmitFileModel::updateSelections(SubmitFileModel *source) diff --git a/src/plugins/vcsbase/vcsbaseeditor.cpp b/src/plugins/vcsbase/vcsbaseeditor.cpp index 7171851c76..9141a4b620 100644 --- a/src/plugins/vcsbase/vcsbaseeditor.cpp +++ b/src/plugins/vcsbase/vcsbaseeditor.cpp @@ -67,19 +67,23 @@ /*! \enum VcsBase::EditorContentType - \brief Contents of a VcsBaseEditor and its interaction. + This enum describes the contents of a VcsBaseEditor and its interaction. \value RegularCommandOutput No special handling. - \value LogOutput Log of a file under revision control. Provide 'click on change' - description and 'Annotate' if is the log of a single file. - \value AnnotateOutput Color contents per change number and provide 'click on change' description. - Context menu offers "Annotate previous version". Expected format: + \value LogOutput Log of a file under revision control. Provide a + description of the change that users can click to view detailed + information about the change and \e Annotate for the log of a + single file. + \value AnnotateOutput Color contents per change number and provide a + clickable change description. + Context menu offers annotate previous version functionality. + Expected format: \code <change description>: file line \endcode - \value DiffOutput Diff output. Might includes describe output, which consists of a - header and diffs. Interaction is 'double click in hunk' which - opens the file. Context menu offers 'Revert chunk'. + \value DiffOutput Diff output. Might include describe output, which consists of a + header and diffs. Double-clicking the chunk opens the file. The context + menu offers the functionality to revert the chunk. \sa VcsBase::VcsBaseEditorWidget */ @@ -180,13 +184,14 @@ class AbstractTextCursorHandler : public QObject public: AbstractTextCursorHandler(VcsBaseEditorWidget *editorWidget = 0); - /*! \brief Try to find some matching contents under \a cursor + /*! Tries to find some matching contents under \a cursor. * - * It's the first function to be called because it changes the internal state of the handler. - * Other functions (highlightCurrentContents(), handleCurrentContents(), ...) use the result - * of the matching + * It is the first function to be called because it changes the internal + * state of the handler. Other functions (such as + * highlightCurrentContents() and handleCurrentContents()) use the result + * of the matching. * - * \return true If contents could be found + * Returns \c true if contents could be found. */ virtual bool findContentsUnderCursor(const QTextCursor &cursor); @@ -199,8 +204,8 @@ public: //! Contents matched with the last call to findContentsUnderCursor() virtual QString currentContents() const = 0; - /*! \brief Fill \a menu with contextual actions applying to the contents matched - * with findContentsUnderCursor() + /*! Fills \a menu with contextual actions applying to the contents matched + * with findContentsUnderCursor(). */ virtual void fillContextMenu(QMenu *menu, EditorContentType type) const = 0; @@ -373,7 +378,7 @@ QAction *ChangeTextCursorHandler::createCopyRevisionAction(const QString &change * http://qt-project.org/. * * The URL pattern can be redefined in sub-classes with setUrlPattern(), by default the pattern - * works for hyper-text URL + * works for hyper-text URLs. */ class UrlTextCursorHandler : public AbstractTextCursorHandler { diff --git a/tests/system/objects.map b/tests/system/objects.map index 26dff6f71b..92afa970b0 100644 --- a/tests/system/objects.map +++ b/tests/system/objects.map @@ -117,7 +117,7 @@ :Options_Core::Internal::SettingsDialog {type='Core::Internal::SettingsDialog' unnamed='1' visible='1' windowTitle~='(Options|Preferences)'} :Options_QListView {type='QListView' unnamed='1' visible='1' window=':Options_Core::Internal::SettingsDialog'} :QML Debugging.No_QPushButton {text='No' type='QPushButton' unnamed='1' visible='1' window=':QML Debugging_QMessageBox'} -:QML Debugging_QMessageBox {type='QMessageBox' unnamed='1' visible='1' windowTitle='QML Debugging'} +:QML Debugging_QMessageBox {text='The option will only take effect if the project is recompiled. Do you want to recompile now?' type='QMessageBox' unnamed='1' visible='1'} :QWebPage {type='QWebPage' unnamed='1'} :Qt Creator.Add Bookmark_QToolButton {text='Add Bookmark' type='QToolButton' unnamed='1' visible='1' window=':Qt Creator_Core::Internal::MainWindow'} :Qt Creator.Analyzer Toolbar_QDockWidget {name='Analyzer Toolbar' type='QDockWidget' visible='1' window=':Qt Creator_Core::Internal::MainWindow' windowTitle='Analyzer Toolbar'} diff --git a/tests/system/shared/classes.py b/tests/system/shared/classes.py index d7ba25101e..43aa583612 100644 --- a/tests/system/shared/classes.py +++ b/tests/system/shared/classes.py @@ -112,21 +112,22 @@ class ViewConstants: @staticmethod def getToolTipForViewTab(viewTab): if viewTab == ViewConstants.WELCOME: - return ur'Switch to <b>Welcome</b> mode <span style="color: gray; font-size: small">(Ctrl\+|\u2303)1</span>' + toolTip = ur'Switch to <b>Welcome</b> mode <span style="color: gray; font-size: small">(Ctrl\+|\u2303)%d</span>' elif viewTab == ViewConstants.EDIT: - return ur'Switch to <b>Edit</b> mode <span style="color: gray; font-size: small">(Ctrl\+|\u2303)2</span>' + toolTip = ur'Switch to <b>Edit</b> mode <span style="color: gray; font-size: small">(Ctrl\+|\u2303)%d</span>' elif viewTab == ViewConstants.DESIGN: - return ur'Switch to <b>Design</b> mode <span style="color: gray; font-size: small">(Ctrl\+|\u2303)3</span>' + toolTip = ur'Switch to <b>Design</b> mode <span style="color: gray; font-size: small">(Ctrl\+|\u2303)%d</span>' elif viewTab == ViewConstants.DEBUG: - return ur'Switch to <b>Debug</b> mode <span style="color: gray; font-size: small">(Ctrl\+|\u2303)4</span>' + toolTip = ur'Switch to <b>Debug</b> mode <span style="color: gray; font-size: small">(Ctrl\+|\u2303)%d</span>' elif viewTab == ViewConstants.PROJECTS: - return ur'Switch to <b>Projects</b> mode <span style="color: gray; font-size: small">(Ctrl\+|\u2303)5</span>' + toolTip = ur'Switch to <b>Projects</b> mode <span style="color: gray; font-size: small">(Ctrl\+|\u2303)%d</span>' elif viewTab == ViewConstants.ANALYZE: - return ur'Switch to <b>Analyze</b> mode <span style="color: gray; font-size: small">(Ctrl\+|\u2303)6</span>' + toolTip = ur'Switch to <b>Analyze</b> mode <span style="color: gray; font-size: small">(Ctrl\+|\u2303)%d</span>' elif viewTab == ViewConstants.HELP: - return ur'Switch to <b>Help</b> mode <span style="color: gray; font-size: small">(Ctrl\+|\u2303)7</span>' + toolTip = ur'Switch to <b>Help</b> mode <span style="color: gray; font-size: small">(Ctrl\+|\u2303)%d</span>' else: return None + return toolTip % (viewTab + 1) class SubprocessType: QT_WIDGET=0 diff --git a/tests/system/shared/editor_utils.py b/tests/system/shared/editor_utils.py index 5ff38ef1b1..ef48fdfd39 100644 --- a/tests/system/shared/editor_utils.py +++ b/tests/system/shared/editor_utils.py @@ -156,7 +156,7 @@ def verifyHoveringOnEditor(editor, lines, additionalKeyPresses, expectedTypes, e test.warning("Could not get %s for line containing pattern '%s'" % (expectedType,line)) else: if expectedType == "ColorTip": - __handleColorTips__(tip, expectedVals) + __handleColorTips__(tip, expectedVals, altVal) elif expectedType == "TextTip": __handleTextTips__(tip, expectedVals, altVal) elif expectedType == "WidgetTip": @@ -203,20 +203,32 @@ def __handleTextTips__(textTip, expectedVals, alternativeVals): # param expectedColor a single string holding the color the ColorTip should have # Attention: because of being a non-standard Qt object it's not possible to # verify colors which are (semi-)transparent! -def __handleColorTips__(colTip, expectedColor): +def __handleColorTips__(colTip, expectedColor, alternativeColor): + def uint(value): + if value < 0: + return 0xffffffff + value + 1 + return value + cmp = QColor() cmp.setNamedColor(expectedColor) - if cmp.alpha() != 255: + if alternativeColor: + alt = QColor() + alt.setNamedColor(alternativeColor) + if cmp.alpha() != 255 or alternativeColor and alt.alpha() != 255: test.warning("Cannot handle transparent colors - cancelling this verification") return dPM = QPixmap.grabWidget(colTip, 1, 1, colTip.width-2, colTip.height-2) img = dPM.toImage() rgb = img.pixel(1, 1) rgb = QColor(rgb) - if rgb.rgba() == cmp.rgba(): + if rgb.rgba() == cmp.rgba() or alternativeColor and rgb.rgba() == alt.rgba(): test.passes("ColorTip verified") else: - test.fail("ColorTip does not match - expected color '%s' got '%s'" % (cmp.rgb(), rgb.rgb())) + altColorText = "" + if alternativeColor: + altColorText = " or '%X'" % uint(alt.rgb()) + test.fail("ColorTip does not match - expected color '%X'%s got '%X'" + % (uint(cmp.rgb()), altColorText, uint(rgb.rgb()))) # function that checks whether all expected properties (including their values) # match the given properties @@ -332,7 +344,7 @@ def addBranchWildcardToRoot(rootNode): def openDocument(treeElement): try: - selectFromCombo(":Qt Creator_Core::Internal::NavComboBox", "Open Documents") + selectFromCombo(":Qt Creator_Core::Internal::NavComboBox", "Projects") navigator = waitForObject(":Qt Creator_Utils::NavigationTreeView") try: item = waitForObjectItem(navigator, treeElement, 3000) diff --git a/tests/system/shared/project.py b/tests/system/shared/project.py index a3f1a9d6e2..f5aa4d3298 100644 --- a/tests/system/shared/project.py +++ b/tests/system/shared/project.py @@ -612,8 +612,9 @@ def addCPlusPlusFileToCurrentProject(name, template, forceOverwrite=False): "visible='1' window=%s}" % window) replaceEditorContent(lineEdit, name) clickButton(waitForObject(":Next_QPushButton")) + fileExistedBefore = os.path.exists(os.path.join(basePath, name)) __createProjectHandleLastPage__() - if (os.path.exists(os.path.join(basePath, name))): + if (fileExistedBefore): overwriteDialog = "{type='Core::Internal::PromptOverwriteDialog' unnamed='1' visible='1'}" waitForObject(overwriteDialog) if forceOverwrite: diff --git a/tests/system/shared/qtcreator.py b/tests/system/shared/qtcreator.py index eecedba839..de2238c93c 100644 --- a/tests/system/shared/qtcreator.py +++ b/tests/system/shared/qtcreator.py @@ -91,7 +91,7 @@ def waitForCleanShutdown(timeOut=10): shutdownDone = (str(appCtxt)=="") if platform.system() in ('Windows','Microsoft'): # cleaning helper for running on the build machines - __checkForQmlViewer__() + __checkForQmlViewerAndQmlScene__() endtime = datetime.utcnow() + timedelta(seconds=timeOut) while not shutdownDone: # following work-around because os.kill() works for win not until python 2.7 @@ -116,18 +116,19 @@ def waitForCleanShutdown(timeOut=10): if not shutdownDone and datetime.utcnow() > endtime: break -def __checkForQmlViewer__(): - tasks = subprocess.Popen("tasklist /FI \"IMAGENAME eq qmlviewer.exe\"", shell=True, - stdout=subprocess.PIPE) - output = tasks.communicate()[0] - tasks.stdout.close() - if "INFO: No tasks are running which match the specified criteria." in output: - return - else: - if subprocess.call("taskkill /F /FI \"IMAGENAME eq qmlviewer.exe\"", shell=True) == 0: - print "Killed still running qmlviewer" +def __checkForQmlViewerAndQmlScene__(): + for qmlHelper in ['qmlviewer.exe', 'qmlscene.exe']: + tasks = subprocess.Popen("tasklist /FI \"IMAGENAME eq %s\"" % qmlHelper, shell=True, + stdout=subprocess.PIPE) + output = tasks.communicate()[0] + tasks.stdout.close() + if "INFO: No tasks are running which match the specified criteria." in output: + continue else: - print "qmlviewer is still running - failed to kill it" + if subprocess.call("taskkill /F /FI \"IMAGENAME eq %s\"" % qmlHelper, shell=True) == 0: + print "Killed still running %s" % qmlHelper + else: + print "%s is still running - failed to kill it" % qmlHelper def __removeTestingDir__(): def __removeIt__(directory): diff --git a/tests/system/shared/utils.py b/tests/system/shared/utils.py index ecfe6523cd..335f6ce187 100644 --- a/tests/system/shared/utils.py +++ b/tests/system/shared/utils.py @@ -445,7 +445,8 @@ def checkDebuggingLibrary(kitIDs): buildLogWindow = ("window={name='QtSupport__Internal__ShowBuildLog' type='QDialog' " "visible='1' windowTitle?='Debugging Helper Build Log*'}") treeWidget = waitForObject(":QtSupport__Internal__QtVersionManager.qtdirList_QTreeWidget") - if str(treeWidget.currentItem().text(0)) in kitStrings.values(): + qtVersion = str(treeWidget.currentItem().text(0)) + if qtVersion in kitStrings.values(): detailsButton = waitForObject("{%s type='Utils::DetailsButton' text='Details' " "visible='1' unnamed='1' occurrence='2'}" % container) ensureChecked(detailsButton) @@ -457,14 +458,16 @@ def checkDebuggingLibrary(kitIDs): buildLog = waitForObject("{type='QPlainTextEdit' name='log' visible='1' %s}" % buildLogWindow) if str(buildLog.plainText).endswith('Build succeeded.'): built += 1 + test.log("Successfully built GDB helper for Qt version %s" % qtVersion) else: failed += 1 - test.fail("Building GDB Helper failed", + test.fail("Building GDB Helper for Qt version %s failed" % qtVersion, buildLog.plainText) clickButton(waitForObject("{type='QPushButton' text='Close' unnamed='1' " "visible='1' %s}" % buildLogWindow)) else: built += 1 + test.log("GDB helper for Qt version %s is %s" % (qtVersion, str(gdbHelperStat.text))) ensureChecked(detailsButton, False) return (built, failed) # end of internal function for iterateQtVersions @@ -472,6 +475,7 @@ def checkDebuggingLibrary(kitIDs): qtVersionsOfKits = zip(kits, qtv) wantedKits = Targets.getTargetsAsStrings(kitIDs) kitsQtV = dict([i for i in qtVersionsOfKits if i[0] in wantedKits]) + test.log("Checking debug libraries for the following kit:Qt combinations: %s" % kitsQtV) tv, builtAndFailedList = iterateQtVersions(False, True, __checkDebugLibsInternalFunc__, kitsQtV) built = failed = 0 for current in builtAndFailedList: @@ -486,7 +490,8 @@ def checkDebuggingLibrary(kitIDs): if built == len(kitIDs): test.log("Function executed for all given kits.") else: - test.fatal("Something's wrong - function has skipped some kits.") + test.fatal("Something's wrong - function has skipped some kits.", + "Expected %s kits but %s are built." % (len(kitIDs), built)) return failed == 0 # function that opens Options Dialog and parses the configured Qt versions diff --git a/tests/system/suite_QMLS/tst_QMLS05/test.py b/tests/system/suite_QMLS/tst_QMLS05/test.py index 008fb92314..926b70936b 100644 --- a/tests/system/suite_QMLS/tst_QMLS05/test.py +++ b/tests/system/suite_QMLS/tst_QMLS05/test.py @@ -47,7 +47,11 @@ def main(): invokeMenuItem("File", "Save All") # activate menu and apply 'Refactoring - Split initializer' numLinesExpected = len(str(editorArea.plainText).splitlines()) + 4 - invokeContextMenuItem(editorArea, "Refactoring", "Split Initializer") + try: + invokeContextMenuItem(editorArea, "Refactoring", "Split Initializer") + except: + # If menu item is disabled it needs to reopen the menu for updating + invokeContextMenuItem(editorArea, "Refactoring", "Split Initializer") # wait until refactoring ended waitFor("len(str(editorArea.plainText).splitlines()) == numLinesExpected", 5000) # verify if refactoring was properly applied - each part on separate line diff --git a/tests/system/suite_QMLS/tst_QMLS06/test.py b/tests/system/suite_QMLS/tst_QMLS06/test.py index 8c998e8fa6..7989883b7d 100644 --- a/tests/system/suite_QMLS/tst_QMLS06/test.py +++ b/tests/system/suite_QMLS/tst_QMLS06/test.py @@ -41,7 +41,11 @@ def main(): invokeMenuItem("File", "Save All") # invoke Refactoring - Wrap Component in Loader numLinesExpected = len(str(editorArea.plainText).splitlines()) + 10 - invokeContextMenuItem(editorArea, "Refactoring", "Wrap Component in Loader") + try: + invokeContextMenuItem(editorArea, "Refactoring", "Wrap Component in Loader") + except: + # If menu item is disabled it needs to reopen the menu for updating + invokeContextMenuItem(editorArea, "Refactoring", "Wrap Component in Loader") # wait until refactoring ended waitFor("len(str(editorArea.plainText).splitlines()) >= numLinesExpected", 5000) # verify if refactoring was properly applied diff --git a/tests/system/suite_QMLS/tst_QMLS07/test.py b/tests/system/suite_QMLS/tst_QMLS07/test.py index f3b118f841..5f942cfa44 100644 --- a/tests/system/suite_QMLS/tst_QMLS07/test.py +++ b/tests/system/suite_QMLS/tst_QMLS07/test.py @@ -40,7 +40,11 @@ def main(): invokeMenuItem("File", "Save All") # invoke Refactoring - Add a message suppression comment. numLinesExpected = len(str(editorArea.plainText).splitlines()) + 1 - invokeContextMenuItem(editorArea, "Refactoring", "Add a Comment to Suppress This Message") + try: + invokeContextMenuItem(editorArea, "Refactoring", "Add a Comment to Suppress This Message") + except: + # If menu item is disabled it needs to reopen the menu for updating + invokeContextMenuItem(editorArea, "Refactoring", "Add a Comment to Suppress This Message") # wait until refactoring ended waitFor("len(str(editorArea.plainText).splitlines()) >= numLinesExpected", 5000) # verify if refactoring was properly applied diff --git a/tests/system/suite_debugger/tst_debug_empty_main/test.py b/tests/system/suite_debugger/tst_debug_empty_main/test.py index 6c8de770d7..a055bcd0a9 100644 --- a/tests/system/suite_debugger/tst_debug_empty_main/test.py +++ b/tests/system/suite_debugger/tst_debug_empty_main/test.py @@ -91,6 +91,8 @@ def __handleAppOutputWaitForDebuggerFinish__(): "Verifying whether debugging has finished.") def performDebugging(workingDir, projectName, checkedTargets): + # for checking if it's a plain C application (as project names are set to match project type) + sampleC = re.compile("SampleC\d{3}") for kit, config in iterateBuildConfigs(len(checkedTargets), "Debug"): test.log("Selecting '%s' as build config" % config) selectBuildConfig(len(checkedTargets), kit, config) @@ -111,7 +113,10 @@ def performDebugging(workingDir, projectName, checkedTargets): invokeMenuItem("Debug", "Toggle Breakpoint") clickButton(waitForObject(":*Qt Creator.Start Debugging_Core::Internal::FancyToolButton")) handleDebuggerWarnings(config, isMsvc) - clickButton(waitForObject(":*Qt Creator.Continue_Core::Internal::FancyToolButton")) + # on Mac the breakpoint won't get hit if it's a C++ based application and the breakpoint is + # set to an empty code line inside an empty main + if platform.system() != "Darwin" or sampleC.match(projectName): + clickButton(waitForObject(":*Qt Creator.Continue_Core::Internal::FancyToolButton")) __handleAppOutputWaitForDebuggerFinish__() removeOldBreakpoints() deleteAppFromWinFW(workingDir, projectName, False) diff --git a/tests/system/suite_debugger/tst_simple_analyze/test.py b/tests/system/suite_debugger/tst_simple_analyze/test.py index 6ebee1a1d3..9910052f40 100644 --- a/tests/system/suite_debugger/tst_simple_analyze/test.py +++ b/tests/system/suite_debugger/tst_simple_analyze/test.py @@ -94,7 +94,7 @@ def main(): "Internal::QmlProfilerEventsMainView").model() if qtVersion.startswith("5."): compareEventsTab(model, "events_qt50.tsv") - numberOfMsRows = 4 + numberOfMsRows = 3 else: if qtVersion.startswith("4.8"): compareEventsTab(model, "events_qt48.tsv") @@ -104,7 +104,7 @@ def main(): test.compare(dumpItems(model, column=colPercent)[0], '100.00 %') for i in [colTotal, colMean, colMedian, colLongest, colShortest]: for item in dumpItems(model, column=i)[:numberOfMsRows]: - test.verify(item.endswith(' ms')) + test.verify(item.endswith(' ms'), "Verify that '%s' ends with ' ms'" % item) for row in range(model.rowCount()): if str(model.index(row, colCalls).data()) == "1": for col in [colMedian, colLongest, colShortest]: diff --git a/tests/system/suite_editors/tst_modify_readonly/test.py b/tests/system/suite_editors/tst_modify_readonly/test.py index 11a29a5c72..92a4426bab 100644 --- a/tests/system/suite_editors/tst_modify_readonly/test.py +++ b/tests/system/suite_editors/tst_modify_readonly/test.py @@ -132,6 +132,7 @@ def testSaveChangesAndMakeWritable(modifiedFiles, readOnlyFiles): "visible='1' window=%s}" % saveDlgStr)) def checkOpenDocumentsContains(itemName): + selectFromCombo(":Qt Creator_Core::Internal::NavComboBox", "Open Documents") openDocsTreeViewModel = waitForObject(":OpenDocuments_Widget").model() result = None found = False diff --git a/tests/system/suite_editors/tst_qml_editor/test.py b/tests/system/suite_editors/tst_qml_editor/test.py index 06a256a015..ae2a3f12b6 100644 --- a/tests/system/suite_editors/tst_qml_editor/test.py +++ b/tests/system/suite_editors/tst_qml_editor/test.py @@ -176,15 +176,17 @@ def testHovering(): lines=['color:\s*"black"', 'color:\s*"#3E606F"'] additionalKeyPresses = ["<Left>"] expectedValues = ["black", "#3E606F"] + alternativeValues = [None, "#39616B"] expectedTypes = ["ColorTip", "ColorTip"] - verifyHoveringOnEditor(editor, lines, additionalKeyPresses, expectedTypes, expectedValues) + verifyHoveringOnEditor(editor, lines, additionalKeyPresses, expectedTypes, expectedValues, alternativeValues) doubleClickFile(navTree, "Core.ListMenu\\.qml") editor = waitForObject(":Qt Creator_QmlJSEditor::QmlJSTextEditorWidget") lines=['Rectangle\s*\{.*color:\s*"#D1DBBD"', 'NumberAnimation\s*\{\s*.*Easing.OutQuint\s*\}'] additionalKeyPresses = ["<Left>", "<Left>", "<Left>", "<Left>"] expectedTypes = ["ColorTip", "TextTip"] expectedValues = ["#D1DBBD", {"text":"number"}] - verifyHoveringOnEditor(editor, lines, additionalKeyPresses, expectedTypes, expectedValues) + alternativeValues = ["#D6DBBD", None] + verifyHoveringOnEditor(editor, lines, additionalKeyPresses, expectedTypes, expectedValues, alternativeValues) def doubleClickFile(navTree, file): global templateDir diff --git a/tests/system/suite_general/tst_openqt_creator/testdata/projecttree_creator.tsv b/tests/system/suite_general/tst_openqt_creator/testdata/projecttree_creator.tsv index a909061d28..4dc7112ab9 100644 --- a/tests/system/suite_general/tst_openqt_creator/testdata/projecttree_creator.tsv +++ b/tests/system/suite_general/tst_openqt_creator/testdata/projecttree_creator.tsv @@ -535,133 +535,7 @@ "qtmobility-systeminfo.qmltypes" "4" "qtmultimediakit.qmltypes" "4" "qtwebkit.qmltypes" "4" -"qmldesigner/propertyeditor/Qt" "3" -"images" "4" -"alignmentbottom-h-icon.png" "5" -"alignmentbottom-icon.png" "5" -"alignmentcenterh-h-icon.png" "5" -"alignmentcenterh-icon.png" "5" -"alignmentleft-h-icon.png" "5" -"alignmentleft-icon.png" "5" -"alignmentmiddle-h-icon.png" "5" -"alignmentmiddle-icon.png" "5" -"alignmentright-h-icon.png" "5" -"alignmentright-icon.png" "5" -"alignmenttop-h-icon.png" "5" -"alignmenttop-icon.png" "5" -"apply.png" "5" -"behaivour.png" "5" -"blended-image-icon.png" "5" -"bold-h-icon.png" "5" -"bold-icon.png" "5" -"button.png" "5" -"cancel.png" "5" -"default-icon.png" "5" -"downArrow.png" "5" -"expression.png" "5" -"extended.png" "5" -"grid-icon.png" "5" -"icon_color_gradient.png" "5" -"icon_color_none.png" "5" -"icon_color_solid.png" "5" -"image-icon.png" "5" -"italic-h-icon.png" "5" -"italic-icon.png" "5" -"item-icon.png" "5" -"layout.png" "5" -"leftArrow.png" "5" -"list-icon.png" "5" -"mouse-area-icon.png" "5" -"placeholder.png" "5" -"rect-icon.png" "5" -"reset-button.png" "5" -"rightArrow.png" "5" -"standard.png" "5" -"strikeout-h-icon.png" "5" -"strikeout-icon.png" "5" -"submenu.png" "5" -"text-edit-icon.png" "5" -"text-icon.png" "5" -"underline-h-icon.png" "5" -"underline-icon.png" "5" -"upArrow.png" "5" -"anchorbottom.css" "4" -"anchorbox.css" "4" -"anchorfill.css" "4" -"anchorhorizontal.css" "4" -"anchorleft.css" "4" -"anchorright.css" "4" -"anchorspacer.css" "4" -"anchortop.css" "4" -"anchorvertical.css" "4" -"applybutton.css" "4" -"aspectlock.css" "4" -"cancelbutton.css" "4" -"checkbox_tr.css" "4" -"layoutWidget.css" "4" -"propertyEditor.css" "4" -"specialCheckBox.css" "4" -"styledbuttonleft.css" "4" -"styledbuttonmiddle.css" "4" -"styledbuttonright.css" "4" -"switch.css" "4" -"typeLabel.css" "4" "qmlicons" "3" -"Qt/16x16" "4" -"BorderImage.png" "5" -"BusyIndicator.png" "5" -"Button.png" "5" -"ButtonColumn.png" "5" -"ButtonRow.png" "5" -"CheckBox.png" "5" -"ChoiceList.png" "5" -"ColorAnimation.png" "5" -"Component.png" "5" -"CountBubble.png" "5" -"DatePickerDialog.png" "5" -"Flickable.png" "5" -"Flipable.png" "5" -"FocusScope.png" "5" -"GridView.png" "5" -"Image.png" "5" -"InfoBanner.png" "5" -"item-icon16.png" "5" -"Item.png" "5" -"ListButton.png" "5" -"ListDelegate.png" "5" -"ListView.png" "5" -"MoreIndicator.png" "5" -"MouseArea.png" "5" -"PageIndicator.png" "5" -"ParallelAnimation.png" "5" -"PathView.png" "5" -"PauseAnimation.png" "5" -"ProgressBar.png" "5" -"PropertyChanges.png" "5" -"RadioButton.png" "5" -"RatingIndicator.png" "5" -"Rectangle.png" "5" -"SequentialAnimation.png" "5" -"Slider.png" "5" -"State.png" "5" -"Switch.png" "5" -"TabBar.png" "5" -"TabButton.png" "5" -"Text.png" "5" -"TextArea.png" "5" -"TextEdit.png" "5" -"TextField.png" "5" -"TextInput.png" "5" -"TimePickerDialog.png" "5" -"ToolBar.png" "5" -"Transition.png" "5" -"Tumbler.png" "5" -"TumblerButton.png" "5" -"TumblerColumn.png" "5" -"TumblerDialog.png" "5" -"Window.png" "5" -"QtWebkit/16x16" "4" -"WebView.png" "5" "schemes" "3" "MS_Visual_C++.kms" "4" "Xcode.kms" "4" @@ -792,12 +666,6 @@ "wizard_sample.xml" "6" "README.txt" "5" "welcomescreen" "3" -"qtcreator/externaltools" "4" -"lrelease.xml" "5" -"lupdate.xml" "5" -"qmlviewer.xml" "5" -"sort.xml" "5" -"qtcreator" "4" "translations" "1" "translations.pro" "2" "qtcreator" "2" diff --git a/tests/system/suite_general/tst_session_handling/test.py b/tests/system/suite_general/tst_session_handling/test.py index db53e9597f..6079a2f06f 100644 --- a/tests/system/suite_general/tst_session_handling/test.py +++ b/tests/system/suite_general/tst_session_handling/test.py @@ -129,6 +129,7 @@ def checkNavigator(expectedRows, message): test.compare(expectedRows, len(__iterateChildren__(navigatorModel, QModelIndex())), message) def checkOpenDocuments(expectedRows, message): + selectFromCombo(":Qt Creator_Core::Internal::NavComboBox", "Open Documents") openDocsWidget = waitForObject(":OpenDocuments_Widget") test.compare(openDocsWidget.model().rowCount(), expectedRows, message) diff --git a/tests/system/suite_tools/tst_git_clone/test.py b/tests/system/suite_tools/tst_git_clone/test.py index 3f010ec8ea..0bc5400bc0 100644 --- a/tests/system/suite_tools/tst_git_clone/test.py +++ b/tests/system/suite_tools/tst_git_clone/test.py @@ -41,12 +41,12 @@ def verifyCloneLog(targetDir, canceled): "Searching for git parameters in clone log") test.verify(("Stopping..." in str(cloneLog.plainText)) ^ (not canceled), "Searching for 'Stopping...' in clone log") - test.verify(("'" + cloneDir + "'..." in str(cloneLog.plainText)), - "Searching for clone directory in clone log") if canceled: result = "The process terminated in an abnormal way." summary = "Failed." else: + test.verify(("'" + cloneDir + "'..." in str(cloneLog.plainText)), + "Searching for clone directory in clone log") result = "The process terminated with exit code 0." summary = "Succeeded." test.verify((result in str(cloneLog.plainText)), |