Correct typos in doxygen comments

[platform/framework/native/appfw.git] / inc / FIoDatabase.h

diff --git a/inc/FIoDatabase.h b/inc/FIoDatabase.h
index a89f95e..abbbf6d 100644 (file)
--- a/inc/FIoDatabase.h
+++ b/inc/FIoDatabase.h
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -291,8 +290,7 @@ public:
        virtual ~Database(void);
 
        /**
-       * @if OSPDEPREC
-       * @{
+       * @cond OSPDEPREC
        * Initializes this instance of %Database with the specified parameters. @n
        * This method creates a new database file or opens an existing database file in the read-write mode.
        *
@@ -333,14 +331,12 @@ public:
        * @remarks      To open the database file in the read-only mode,
        *                       use the Database::Construct(const Tizen::Base::String& dbPath, const char* pOpenMode) method
        *                       with "r" as the value for the open mode flag.
-       * @}
-       * @endif
+       * @endcond
        */
        result Construct(const Tizen::Base::String& dbPath, bool createIfNotExist);
 
        /**
-       * @if OSPDEPREC
-       * @{
+       * @cond OSPDEPREC
        * Initializes this instance of %Database with the specified parameters. @n
        * This method creates a new database file or opens an existing database file in the read-only or the read-write mode.
        *
@@ -377,8 +373,7 @@ public:
        *                                                                               - The method has failed to open or create a file. @n
        *                                                                               - An unexpected device failure has occurred as the media ejected suddenly. @n
        *                                                                               - %File corruption is detected.
-       * @}
-       * @endif
+       * @endcond
        */
        result Construct(const Tizen::Base::String& dbPath, long openMode, long option);
 
@@ -421,6 +416,7 @@ public:
        * identical key value in same device. However, the secure files created by this method cannot be accessed in other devices.
        *
        * @since                2.0
+       * @feature              %http://tizen.org/feature/database.encryption
        *
        * @return               An error code
        * @param[in]    dbPath                                  The path of the database file to open or create
@@ -446,7 +442,9 @@ public:
        * @exception    E_IO                                    Either of the following conditions has occurred: @n
        *                                                                               - An unexpected device failure has occurred as the media ejected suddenly. @n
        *                                                                               - %File corruption is detected. @n
-       * @exception    E_UNSUPPORTED_OPERATION This operation is not supported.
+       * @exception    E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. For more information, see
+       *                                                                               <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+       * @remarks              Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
        */
        result Construct(const Tizen::Base::String& dbPath, const char* pOpenMode, const Tizen::Base::ByteBuffer& secretKey);
 
@@ -750,6 +748,7 @@ public:
        *                                       For path compatibility, see @ref CompIoPathPage "here".
        *                                       For exception compatibility, see @ref CompDatabaseExceptionPage "here".
        * @endif
+       * @feature                      %http://tizen.org/feature/database.encryption
        *
        * @return               An error code
        * @param[in]    normalDbPath                    The normal (non-encrypted) database file path
@@ -771,7 +770,9 @@ public:
        *                                                                               - An unexpected device failure has occurred as the media ejected suddenly. @n
        *                                                                               - %File corruption is detected.
        * @exception    E_SYSTEM                                The method cannot proceed due to a severe system error.
-       * @exception    E_UNSUPPORTED_OPERATION This operation is not supported.
+       * @exception    E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. For more information, see
+       *                                                                               <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+       * @remarks              Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
        */
        static result ConvertToSecureDatabase(const Tizen::Base::String& normalDbPath, const Tizen::Base::String& secureDbPath,
                        const Tizen::Base::ByteBuffer& secretKey);