X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFSecPrivacyInfo.h;h=05b5ac3aabdf7728a9883d23295c5a93a64286cf;hb=07a771d39ebf4c7f26a04aeb3e06f9d7eb1c6dc2;hp=2111d4c57ce14ee1784caaad3a27387ea9e4c35b;hpb=27f1388665067f69d5eb64e0cae6bb5f4250beec;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FSecPrivacyInfo.h b/inc/FSecPrivacyInfo.h index 2111d4c..05b5ac3 100755 --- a/inc/FSecPrivacyInfo.h +++ b/inc/FSecPrivacyInfo.h @@ -13,50 +13,48 @@ // 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 - + 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 * * @final This class is not intended for extension. * * The %PrivacyInfo class represents the privacy information. -* %PrivacyInfo provides methods to retrieve the name and description of privilege. +* 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,23 +71,23 @@ 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 is not exist. + * @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 * - * @return The privacy ID. + * @return The privacy ID * */ Tizen::Base::String GetId(void) const; - + /** * Checks whether the privacy setting is enabled. * @@ -100,62 +98,65 @@ 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 the localized display name of privacy. * * @since 2.1 * - * @return The display name of privacy, else an empty string is returned if there is no value. + * @return The display name of privacy, @n + * else an empty string is returned if there is no value * */ Tizen::Base::String GetDisplayName(void) const; - + /** * Gets the localized description of privacy. * * @since 2.1 * - * @return The description of privacy, else an empty string is returned if there is no value. + * @return The description of privacy, @n + * else an empty string is returned if there is no value * */ 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_ - +