Enable build with iniparser v 3.1
[platform/framework/native/appfw.git] / inc / FSecPrivacyInfo.h
index 2cd714e..05b5ac3 100755 (executable)
 // See the License for the specific language governing permissions and
 // limitations under the License.
 //
+
 /**
-* @file    FSecPrivacyInfo.h
-* @brief  This is the header file for the %PrivacyInfo class.
+* @file                FSecPrivacyInfo.h
+* @brief       This is the header file for the %PrivacyInfo class.
 *
 * This header file contains the declarations of the %PrivacyInfo class.
 */
+
 #ifndef _FSEC_PRIVACY_INFO_H_
 #define _FSEC_PRIVACY_INFO_H_
+
 #include <FBaseObject.h>
+
 namespace Tizen { namespace Security
 {
+
 /**
 * @class       PrivacyInfo
-* @brief       This class represents the privacy information.
+* @brief       This class provides methods for the privacy information.
 *
 * @since       2.1
 *
@@ -40,23 +40,21 @@ namespace Tizen { namespace Security
 * The %PrivacyInfo class represents the privacy information.
 * This class provides methods to retrieve the name and description of privilege.
 */
+
 class _OSP_EXPORT_ PrivacyInfo
        : public Tizen::Base::Object
 {
 
 public:
+
        /**
         * The object is not fully constructed after this constructor is called. @n
         * For full construction, the Construct() method must be called right after calling this constructor.
         *
         * @since               2.1
-        *
-        * @remarks             After creating an instance of this class, the Construct() method must be called explicitly to initialize this instance.
         */
        PrivacyInfo(void);
+
        /**
         * This destructor overrides Tizen::Base::Object::~Object().
         *
@@ -64,7 +62,7 @@ public:
         *
         */
        virtual ~PrivacyInfo(void);
+
        /**
         * Initializes this instance of %PrivacyInfo with the specified parameters.
         *
@@ -73,15 +71,15 @@ public:
         * @return              An error code
         * @param[in]   privacyId                       The privacy ID
         * @param[in]   enable                          Set to @c true to enable the privacy setting, @n
-        *                                  else @c false
+        *                                                                      else @c false
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_ARG           The specified @c privacyId is invalid or the @c privacyId does not exist.
         *
         */
        result Construct(const Tizen::Base::String& privacyId, bool enable = false);
+
        /**
-        * Gets a privacy ID.
+        * Gets the privacy ID.
         *
         * @since               2.1
         *
@@ -89,7 +87,7 @@ public:
         *
         */
        Tizen::Base::String GetId(void) const;
+
        /**
         * Checks whether the privacy setting is enabled.
         *
@@ -100,20 +98,21 @@ public:
         * @see                 SetEnabled()
         */
        bool IsEnabled(void) const;
+
        /**
         * Enables or disables the privacy setting.
         *
         * @since               2.1
         *
-        * @param[in]   enable                  A Boolean value indicating whether the privacy setting is enabled
+        * @param[in]   enable                  @c true if the privacy setting is enabled, @n
+        *                                                              else @c false
         * @see                 IsEnabled()
         *
         */
        void SetEnabled(bool enable);
+
        /**
-        * Gets a localized display name of privacy.
+        * Gets the localized display name of privacy.
         *
         * @since               2.1
         *
@@ -122,9 +121,9 @@ public:
         *
         */
        Tizen::Base::String GetDisplayName(void) const;
+
        /**
-        * Gets a localized description of privacy.
+        * Gets the localized description of privacy.
         *
         * @since               2.1
         *
@@ -133,31 +132,31 @@ public:
         *
         */
        Tizen::Base::String GetDescription(void) const;
+
 private:
+
        //
        // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
        //
-       // @param[in]   rhs         An instance of %PrivacyInfo
+       // @param[in]   rhs             An instance of %PrivacyInfo
        //
        PrivacyInfo(const PrivacyInfo& rhs);
+
        //
        // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
        //
-       // @param[in]   rhs          An instance of %PrivacyInfo
+       // @param[in]   rhs             An instance of %PrivacyInfo
        //
        PrivacyInfo& operator =(const PrivacyInfo& rhs);
+
 private:
+
        class _PrivacyInfoImpl* __pImpl;
        friend class _PrivacyInfoImpl;
+
 }; // PrivacyInfo
+
 } } // Tizen::Security
+
 #endif // _FSEC_PRIVACY_INFO_H_
+