doc/privilege-info_doc.h

   1 /*
   2  * Copyright (c) 2014 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 PRIVILEGE_INFO_DOC_H_
  19 #define PRIVILEGE_INFO_DOC_H_
  20
  21
  22 /**
  23  * @ingroup CAPI_SECURITY_FRAMEWORK
  24  * @defgroup CAPI_SECURITY_FRAMEWORK_PRIVILEGE_INFO_MODULE Privilege Info
  25  * @section CAPI_SECURITY_FRAMEWORK_PRIVILEGE_INFO_MODULE_HEADER Requires Header
  26  * \#include <privilege_information.h>
  27  *
  28  * @section CAPI_SECURITY_FRAMEWORK_PRIVILEGE_INFO_MODULE_OVERVIEW Overview
  29  * A library for reading privilege information of the given privilege and API issue version.
  30  * It provides the display name or description of privileges.
  31  * If there's no matching privilege then it shows last token of given privilege or description string for undefined privileges.
  32  *
  33  * @section CAPI_SECURITY_FRAMEWORK_PRIVILEGE_INFO_MODULE_FEATURE Related Features
  34  * This API is related with the following features:\n
  35  * - http://tizen.org/feature/security.privacy_privilege\n
  36  * It is recommended to design feature related codes in your application for reliability.\n
  37  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
  38  * 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
  39  * More details on featuring your application can be found from <a href="https://docs.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
  40  */
  41
  42
  43 #endif /* PRIVILEEGE_INFO_DOC_H_ */