Doc: edit coreplugin docs

Remove \brief commands for functions.
Use standard wording for QDoc commands.
Fix style and grammar issues.
Use the \a command instead of the \c command for attributes
in function descriptions.
Do not use \returns, because it does not exist.

Change-Id: Icd32b519670cb376e246bab3a58fe7e98d2529ea
Reviewed-by: Eike Ziller <eike.ziller@digia.com>

2 files changed, 23 insertions, 23 deletions

diff --git a/src/plugins/coreplugin/actionmanager/actionmanager.cpp b/src/plugins/coreplugin/actionmanager/actionmanager.cpp
index d4ed4f7840..94a6236fb0 100644
--- a/src/plugins/coreplugin/actionmanager/actionmanager.cpp
+++ b/src/plugins/coreplugin/actionmanager/actionmanager.cpp
@@ -169,7 +169,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
@@ -196,7 +196,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
@@ -221,7 +221,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
@@ -243,7 +243,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
@@ -292,7 +292,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()
@@ -310,7 +310,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()
@@ -329,7 +329,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()
 {
@@ -341,7 +341,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
@@ -372,7 +372,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 b49eb5274e..66b07f030e 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.
 */