doc/storage_doc.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17
  18 #ifndef __TIZEN_SYSTEM_STORAGE_DOC_H__
  19 #define __TIZEN_SYSTEM_STORAGE_DOC_H__
  20
  21 /**
  22  * @ingroup CAPI_SYSTEM_FRAMEWORK
  23  * @defgroup CAPI_SYSTEM_STORAGE_MODULE Storage
  24  * @brief  The STORAGE API provides functions to get storage information.
  25  *
  26  * @section CAPI_SYSTEM_STORAGE_MODULE_HEADER Required Header
  27  *   \#include <storage.h> \n
  28  *
  29  * @section CAPI_SYSTEM_STORAGE_MODULE_OVERVIEW Overview
  30  * The STORAGE API provides functions to get storage information.
  31  *
  32  * The type of storage information includes:
  33  * - Root directory
  34  * - Storage type (Internal or External)
  35  * - Storage status
  36  * - Total and available space size
  37  *
  38  * The type of directory information includes:
  39  * - Images
  40  * - Sounds
  41  * - Videos
  42  * - Camera
  43  * - Downloads
  44  * - Music
  45  * - Documents
  46  * - Others
  47  * - System ringtones
  48  *
  49  * @section CAPI_SYSTEM_STORAGE_MODULE_OVERVIEW Related Features
  50  * This API is related with the following features:\n
  51  * - %http://tizen.org/feature/storage.external\n
  52  *
  53  * It is recommended to design feature related codes in your application for reliability.\n
  54  *
  55  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  56  *
  57  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  58  *
  59  * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>feature element description</b>.</a>
  60  *
  61  *
  62  */
  63
  64 #endif /* __TIZEN_SYSTEM_STORAGE_DOC_H__ */