feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: edit projectexplorer API docs

Browse Source 
Fix grammar, punctuation, and style issues. Use standard wording for
QDoc commands. Remove \brief commands from function descriptions.
Move some function descriptions directly above the functions, so
that the \fn command can be removed.

Change-Id: Iedf4f0041af24541a982241f99bd4906e86af916
Reviewed-by: Daniel Teske <daniel.teske@digia.com>
This commit is contained in:
Leena Miettinen
2013-09-10 17:16:10 +02:00
parent c5c501669f
commit 6b99d2bb78
16 changed files with 213 additions and 173 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
src/plugins/projectexplorer/toolchain.cpp
View File

@@ -152,9 +152,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
@@ -181,9 +181,9 @@ void ToolChain::setAutoDetected(bool autodetect)
}
/*!
\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)
@@ -197,7 +197,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
@@ -207,22 +207,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()