From 59a68a307a4b85f1eda9f4f0f45503568c52fcca Mon Sep 17 00:00:00 2001
From: Daniel d'Andrada <daniel.dandrada@nokia.com>
Date: Tue, 14 Sep 2010 11:00:59 +0300
Subject: Changes: MAction - Improve Locations documentation.

RevBy: TrustMe
---
 src/corelib/core/maction.h | 29 +++++++++++++++--------------
 1 file changed, 15 insertions(+), 14 deletions(-)

(limited to 'src')

diff --git a/src/corelib/core/maction.h b/src/corelib/core/maction.h
index e4bd9c70..d4f036f2 100644
--- a/src/corelib/core/maction.h
+++ b/src/corelib/core/maction.h
@@ -43,19 +43,20 @@ class M_EXPORT MAction : public QAction
 
 public:
 
-    /*
-       \brief Possible locations for an action to reside in
-       \detail An action may stay in different locations on the screen, but will have preferred ones.
-       This information is useful if actions should be shifted from one location to another automatically.
+    /*!
+       \brief Possible locations for an action to reside in.
+       An action may stay in different locations on the screen, but will have
+       preferred ones. This information is useful if actions should be shifted
+       from one location to another automatically.
      */
     enum Location {
-        NoLocation = 0x0000,
-        ToolBarPortraitLocation = 0x0001,
-        ToolBarLandscapeLocation = 0x0002,
-        ToolBarLocation = 0x0003,
-        ApplicationMenuLocation = 0x0004,
-        ObjectMenuLocation = 0x0008,
-        EveryLocation = 0xffff
+        NoLocation = 0x0000, /*!< No location. */
+        ToolBarPortraitLocation = 0x0001, /*!< In the tool bar, if in portrait orientation. */
+        ToolBarLandscapeLocation = 0x0002, /*!< In the tool bar, if in landscape orientation. */
+        ToolBarLocation = 0x0003, /*!< In the tool bar, regardless of the orientation. */
+        ApplicationMenuLocation = 0x0004, /*!< In the application menu. */
+        ObjectMenuLocation = 0x0008, /*!< In the object menu. */
+        EveryLocation = 0xffff /*!< In all possible locations. */
     };
 
     Q_DECLARE_FLAGS(Locations, Location)
@@ -99,13 +100,13 @@ public:
     void setIconID(const QString &id);
 
     /**
-       \brief Return the possible location this action may reside in
+       \brief Return the possible locations this action may reside in
      */
     Locations location() const;
 
     /**
-       \brief Set the location this action may reside in
-       \param location value of possible location
+       \brief Set the locations this action may reside in
+       \param location value of possible locations
      */
     void setLocation(Locations location);
 
-- 
cgit v1.2.3