Apply reviewed doxygen header
[platform/framework/native/appfw.git] / inc / FSecPrivacyManager.h
index 168ffb1..52b1beb 100755 (executable)
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2013 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
 // See the License for the specific language governing permissions and
 // limitations under the License.
 //
+
 /**
 * @file                FSecPrivacyManager.h
 * @brief       This is the header file for the %PrivacyManager class.
 *
 * This header file contains the declarations of the %PrivacyManager class.
 */
+
 #ifndef _FSEC_PRIVACY_MANAGER_H_
 #define _FSEC_PRIVACY_MANAGER_H_
+
 #include <FBaseObject.h>
 #include <FAppTypes.h>
 
@@ -35,42 +34,42 @@ class IList;
 
 namespace Tizen { namespace Security
 {
+
 class PrivacyInfo;
+
 /**
- * @class        PrivacyManager
- * @brief        This class gets the privacy information and manages an application's privacy settings.
+ * @class              PrivacyManager
+ * @brief              This class provides methods for managing the privacy information and the application's privacy settings.
  *
- * @since   2.1
+ * @since              2.1
  *
- * @final   This class is not intended for extension.
+ * @final              This class is not intended for extension.
  *
  * The %PrivacyManager class lets an application to get or save application's privacy settings.
  */
+
 class _OSP_EXPORT_ PrivacyManager
        : public Tizen::Base::Object
 {
 public:
+
        /**
-        * Gets the privacy manager instance.
+        * Gets a pointer to the %PrivacyManager instance.
         *
         * @since               2.1
         *
         * @return              A pointer to the %PrivacyManager instance, @n
         *                              else @c null if it fails
         *
-        * @exception   E_SUCCESS                 The method is successful.
-        * @exception   E_SYSTEM                   The method cannot proceed due to a severe system error.
+        * @exception   E_SUCCESS                               The method is successful.
+        * @exception   E_SYSTEM                                The method cannot proceed due to a severe system error.
         *
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
        static PrivacyManager* GetInstance(void);
+
        /**
-        * Gets a list of packages which access user's privacy information.
+        * Gets the list of packages which access user's privacy information.
         *
         * @since               2.1
         * @privlevel   platform
@@ -86,9 +85,9 @@ public:
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
        Tizen::Base::Collection::IList* GetPrivacyAppPackageListN(void) const;
+
        /**
-        * Gets a list of privacy information of a package.
+        * Gets the list of privacy information of a package.
         *
         * @since               2.1
         * @privlevel   platform
@@ -107,7 +106,7 @@ public:
        Tizen::Base::Collection::IList* GetPrivacyInfoListN(const Tizen::App::PackageId& packageId) const;
 
        /**
-        * Sets the specific privacy setting of a package
+        * Sets the privacy setting of the specified package.
         *
         * @since               2.1
         * @privlevel   platform
@@ -115,55 +114,55 @@ public:
         *
         * @return              An error code
         * @param[in]   packageId                               The package ID
-        * @param[in]   privacyInfo                             The privacy setting to be set
-        *
+        * @param[in]   privacyInfo                             The privacy information to set
         * @exception   E_SUCCESS                               The method is successful.
-        * @exception   E_OBJ_NOT_FOUND                 The specified @c packageId is not found in privacy database or @n
-        *                                                                              the package did not be defined to access to the privacy information.
+        * @exception   E_OBJ_NOT_FOUND                 Either of the following conditions has occurred:
+        *                                                                              - The specified @c packageId is not found in privacy database.
+        *                                                                              - The package is not defined to access the privacy information.
         * @exception   E_INVALID_ARG                   The specified @c packageId length is invalid.
         * @exception   E_PRIVILEGE_DENIED              The application does not have the privilege to call this method.
         * @exception   E_SYSTEM                                The method cannot proceed due to a severe system error.
         *
         */
        result SetAppPackagePrivacy(const Tizen::App::PackageId& packageId, const PrivacyInfo& privacyInfo);
+
 private:
+
        //
        // This default constructor is intentionally declared as private to implement the %Singleton semantic.
        //
-       // @since                  2.1
+       // @since               2.1
        //
        PrivacyManager(void);
+
        //
        // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
        //
-       // @since                  2.1
+       // @since               2.1
        //
        PrivacyManager(const PrivacyManager& rhs);
+
        //
        // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
        //
-       // @since                  2.1
+       // @since               2.1
        //
        PrivacyManager& operator =(const PrivacyManager& rhs);
+
        //
        // This destructor is intentionally declared as private to implement the %Singleton semantic.
        //
-       // @since                  2.1
+       // @since               2.1
        //
        virtual ~PrivacyManager(void);
+
 private:
+
        class _PrivacyManagerImpl* __pPrivacyManagerImpl;
        friend class _PrivacyManagerImpl;
+
 }; // PrivacyManager
+
 }} // Tizen::Security
+
 #endif // _FSEC_PRIVACY_MANAGER_H_