update header for Doxygen

[platform/framework/native/content.git] / inc / FCntVideoContentInfo.h

diff --git a/inc/FCntVideoContentInfo.h b/inc/FCntVideoContentInfo.h
index 04aa763..52e52dd 100644 (file)
--- a/inc/FCntVideoContentInfo.h
+++ b/inc/FCntVideoContentInfo.h
@@ -102,16 +102,20 @@ public:
         * @endif
         *
         * @return                      An error code
-        * @param[in]   pContentPath                                    The content path
+        * @param[in]   pContentPath                    The content path @n
+        *                                                              The path should be started with directory path returned by 
+        *                                                              either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
+        *                                                              If the path is @c null,
+        *                                                              use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
+        *                                                              or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*), 
+        *                                                              instead of this method.
         * @exception   E_SUCCESS                                       The method is successful.
         * @exception   E_FILE_NOT_FOUND                The specified file cannot be found or accessed.
         * @exception   E_INVALID_ARG                           The specified input parameter is invalid.
         * @exception   E_OUT_OF_MEMORY         The memory is insufficient.
         * @exception   E_IO                                                            An I/O error has occurred.
         * @exception   E_SYSTEM                                                An internal error has occurred.
-        * @remarks             The @c pContentPath should start with directory path returned by either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
-        *                     If @c pContentPath is @c null, use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
-        *                     or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*).
+        * @remarks             
         */
        result Construct(const Tizen::Base::String* pContentPath);