From: jinbong.lee <jinbong.lee@samsung.com>
Date: Wed, 11 Dec 2024 06:04:12 +0000 (+0900)
Subject: Add document of hal_tdm
X-Git-Tag: accepted/tizen/unified/20250109.175139~4
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=a665c8947030fae3a5c745cd8b9ad0a48d181251;p=platform%2Fhal%2Fapi%2Ftdm.git

Add document of hal_tdm

Change-Id: I5eac57c378498decdbcd0e0f0eb31790b65447c7
Signed-off-by: jinbong.lee <jinbong.lee@samsung.com>
---

diff --git a/doc/hal_tdm_doc.h b/doc/hal_tdm_doc.h
new file mode 100644
index 0000000..8eb2867
--- /dev/null
+++ b/doc/hal_tdm_doc.h
@@ -0,0 +1,58 @@
+/**************************************************************************
+ *
+ * hal-api-tdm
+ *
+ * Copyright 2021 Samsung Electronics co., Ltd. All Rights Reserved.
+ *
+ * Contact: SooChan Lim <sc1.lim@samsung.com>,
+ *          Junkyeong Kim <jk0430.kim@samsung.com>,
+ *          Changyeon Lee <cyeon.lee@samsung.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sub license, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the
+ * next paragraph) shall be included in all copies or substantial portions
+ * of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
+ * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
+ * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+**************************************************************************/
+
+
+#ifndef __TIZEN_HAL_TDM_DOC_H__
+#define __TIZEN_HAL_TDM_DOC_H__
+
+
+/**
+ * @file hal_tdm_doc.h
+ * @brief This file contains high level documentation of the HAL TDM.
+ */
+
+/**
+ * @defgroup HALAPI_HAL_TDM_MODULE TDM
+ * @brief The @ref HALAPI_HAL_API_TDM provides functions for managing display server.
+ *
+ * @section HALAPI_HAL_API_TDM_HEADER Required Header
+ *   \#include <hal-tdm.h>
+ *
+ * @section HALAPI_HAL_TDM_MODULE_OVERVIEW Overview
+ * The TDM functions provides an abstraction interface for display server including:
+ * - Display server interface to user like getting display capablilities, size, format.
+ * - Display control interface like display mode setting, dpms, capture.
+ *
+ * For more information on the TDM features and the macros, see HAL TDM programming guides and tutorials.
+ */
+
+#endif /* __TIZEN_HAL_TDM_DOC_H__ */
\ No newline at end of file