From 00ac1f8918372adec603bbb007b3337f0fb90ab2 Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@digia.com>
Date: Fri, 7 Jun 2013 10:38:26 +0200
Subject: [PATCH] Doc: move imageviewer docs from headers to cpp files

Use standard wording for function docs. Use valid
QDoc commands (\a instead of \param, for example).

Change-Id: I556fdbf686f2f54138617d6784c650a1d973513c
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
---
 src/plugins/imageviewer/imageviewer.cpp              | 6 ++++++
 src/plugins/imageviewer/imageviewer.h                | 7 +------
 src/plugins/imageviewer/imagevieweractionhandler.cpp | 5 +++++
 src/plugins/imageviewer/imagevieweractionhandler.h   | 8 +-------
 4 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/src/plugins/imageviewer/imageviewer.cpp b/src/plugins/imageviewer/imageviewer.cpp
index 58a4e77e8a2..25777c5e5ea 100644
--- a/src/plugins/imageviewer/imageviewer.cpp
+++ b/src/plugins/imageviewer/imageviewer.cpp
@@ -187,6 +187,12 @@ void ImageViewer::scaleFactorUpdate(qreal factor)
     d->ui_toolbar.labelInfo->setText(info);
 }
 
+/*!
+    Tries to change the \a button icon to the icon specified by \a name
+    from the current theme. Returns \c true if icon is updated, \c false
+    otherwise.
+*/
+
 bool ImageViewer::updateButtonIconByTheme(QAbstractButton *button, const QString &name)
 {
     QTC_ASSERT(button, return false);
diff --git a/src/plugins/imageviewer/imageviewer.h b/src/plugins/imageviewer/imageviewer.h
index b5a20689217..14a1774e0fd 100644
--- a/src/plugins/imageviewer/imageviewer.h
+++ b/src/plugins/imageviewer/imageviewer.h
@@ -79,12 +79,7 @@ private slots:
     void playToggled();
 
 private:
-    /*!
-      \brief Try to change button's icon to the one from the current theme.
-      \param button Button where an icon should be changed
-      \param name Icon name in the in the current icon theme
-      \return true if icon is updated, false otherwise
-     */
+
     bool updateButtonIconByTheme(QAbstractButton *button, const QString &name);
     void setPaused(bool paused);
 
diff --git a/src/plugins/imageviewer/imagevieweractionhandler.cpp b/src/plugins/imageviewer/imagevieweractionhandler.cpp
index f5fc2a2674c..4b27ddd75d7 100644
--- a/src/plugins/imageviewer/imagevieweractionhandler.cpp
+++ b/src/plugins/imageviewer/imagevieweractionhandler.cpp
@@ -114,6 +114,11 @@ void ImageViewerActionHandler::createActions()
                       QKeySequence());
 }
 
+/*!
+    Creates a new action with the internal id \a actionId, command id \a id,
+    and keyboard shortcut \a key, and registers it in the action manager.
+*/
+
 void ImageViewerActionHandler::registerNewAction(int actionId, const Core::Id &id,
     const QString &title, const QKeySequence &key)
 {
diff --git a/src/plugins/imageviewer/imagevieweractionhandler.h b/src/plugins/imageviewer/imagevieweractionhandler.h
index fc872f3e918..375ebbfb951 100644
--- a/src/plugins/imageviewer/imagevieweractionhandler.h
+++ b/src/plugins/imageviewer/imagevieweractionhandler.h
@@ -55,13 +55,7 @@ public slots:
     void actionTriggered(int supportedAction);
 
 protected:
-    /*!
-      \brief Create a new action and register this action in the action manager.
-      \param actionId Action's internal id
-      \param id Command id
-      \param title Action's title
-      \param key Key sequence for the commands
-     */
+
     void registerNewAction(int actionId, const Core::Id &id, const QString &title,
                            const QKeySequence &key);