//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
* Initializes this instance of %FileZipper with the specified filepath. @n
- * This method opens an existing zip file in append mode. If the file does not exist, it creates and opens the file in
+ * This method opens an existing zip file in the append mode. If the file does not exist, it creates and opens the file in the
* append mode.
*
* @if OSPCOMPAT
* @endif
*
* @return An error code
- * @param [in] filePath The path of the zip file to open or create
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified path is @c 0 or exceeds system limitations. @n
- * - The specified path contains prohibited character(s). @n
+ * @param [in] filePath The path of the zip file to open or create
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is either @c 0 or exceeds system limitations.
+ * - The specified path contains prohibited character(s).
* - The specified path is invalid.
- * @exception E_ILLEGAL_ACCESS The specified path is not permitted, or
- * access is denied due to insufficient permission.
- * @exception E_IO An unexpected device failure has occurred.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The specified path is not permitted.
+ * - The access is denied due to insufficient permission.
+ * @exception E_IO An unexpected device failure has occurred.
* @remarks The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported.
* @see Tizen::Io::File
*/
* @endif
*
* @return An error code
- * @param [in] filePath The path of the file to add to the zip file
- * @param [in] excludePath Set to @c true to exclude the path and to store only the file name, @n
- * else @c false to insert the entire path name in the zip-archive
- * @param [in] level Set to @c BEST_SPEED or @c BEST_COMPRESSION @n
- * By default, it is set to @c DEFAULT_COMPRESSION.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified path is @c 0 or exceeds system limitations. @n
- * - The specified path contains prohibited character(s). @n
- * - The specified path is invalid.
- * @exception E_ILLEGAL_ACCESS The specified path is not permitted, or
- * access is denied due to insufficient permission.
- * @exception E_FILE_NOT_FOUND The specified file cannot be found.
+ * @param [in] filePath The path of the file to add to the zip file
+ * @param [in] excludePath Set to @c true to exclude the path and to store only the file name, @n
+ * else @c false to insert the entire path name in the zip-archive
+ * @param [in] level Set to @c BEST_SPEED or @c BEST_COMPRESSION @n
+ * By default, it is set to @c DEFAULT_COMPRESSION.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is either @c 0 or exceeds system limitations.
+ * - The specified path contains prohibited character(s).
+ * - The specified path is invalid.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The specified path is not permitted.
+ * - The access is denied due to insufficient permission.
+ * @exception E_FILE_NOT_FOUND The specified file cannot be found.
* @exception E_FILE_ALREADY_EXIST The specified file already exists in the zip-archive, but the
* flag for overwriting the file is not set.
- * @exception E_IO An unexpected device failure has occurred.
- * @remarks The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported.
- * @remarks If the value of @c excludePath is set to @c false, full path name is inserted to the zip-
+ * @exception E_IO An unexpected device failure has occurred.
+ * @remarks
+ * - The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported.
+ * - If the value of @c excludePath is set to @c false, the full path name is inserted to the zip-
* archive. Therefore, developers should handle the path name carefully. @n
- * For example, if you add @b '/Test/data.txt' file to the zip-archive, and if the
- * @c excludePath parameter is set to @c false, while unzipping the file in @b '/Test'
+ * For example, if you add @b '/Test/data.txt' file to the zip-archive, and if
+ * @c excludePath is set to @c false, while unzipping the file in @b '/Test'
* directory, then the file is extracted in @b '/Test/Test/data.txt'.
* @see Tizen::Io::File
*/