doc/diagnostics_doc.h

   1 /*
   2  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   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  * @ingroup   CAPI_SYSTEM_FRAMEWORK
  19  * @defgroup  CAPI_SYSTEM_DIAGNOSTICS_MODULE Diagnostics
  20  * @brief     The @ref CAPI_SYSTEM_DIAGNOSTICS_MODULE API provides functions to receive crash reports and request logs from other apps.
  21  *
  22  * @section   CAPI_SYSTEM_DIAGNOSTICS_MODULE_HEADER Required Header
  23  *            \#include <diagnostics.h>
  24  *
  25  * @section   CAPI_SYSTEM_DIAGNOSTICS_MODULE_OVERVIEW Overview
  26  * This @ref CAPI_SYSTEM_DIAGNOSTICS_MODULE API allows applications to receive notification about newly created crash report,
  27  * as well as request other apps to dump their logs in real time. Moreover, functions for reading crash and log contents are provided.
  28  *
  29  * @section   CAPI_SYSTEM_DIAGNOSTICS_MODULE_FEATURE Realted Features
  30  *
  31  * This API is related with the following feature:\n
  32  * - %http://tizen.org/feature/diagnostics\n
  33  *
  34  * It is recommended to design feature related codes in your application for reliability.\n
  35  *
  36  * 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
  37  *
  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  *
  40  * 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</b>.</a>
  41  */