Add '@addtogroup' tag to generate doxygen page
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / text / rendering-backend.h
old mode 100644 (file)
new mode 100755 (executable)
index 522a307..6c266f8
@@ -1,8 +1,8 @@
-#ifndef __DALI_TOOLKIT_RENDERING_BACKEND_H__
-#define __DALI_TOOLKIT_RENDERING_BACKEND_H__
+#ifndef DALI_TOOLKIT_RENDERING_BACKEND_H
+#define DALI_TOOLKIT_RENDERING_BACKEND_H
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,23 +23,33 @@ namespace Dali
 
 namespace Toolkit
 {
+/**
+ * @addtogroup dali_toolkit_controls_text_controls
+ * @{
+ */
 
 namespace Text
 {
 
-// The type of text renderer required
+/**
+ * @brief Enumeration for the type of text renderer required.
+ * @SINCE_1_0.0
+ */
 enum RenderingType
 {
-  RENDERING_BASIC,       ///< A bitmap-based reference implementation
-  RENDERING_SHARED_ATLAS ///< A bitmap-based solution where renderers can share a texture atlas
+  RENDERING_SHARED_ATLAS, ///< A bitmap-based solution where renderers can share a texture atlas @SINCE_1_0.0
+  RENDERING_VECTOR_BASED  ///< A solution where glyphs are stored as vectors (scalable). Requires highp shader support. @SINCE_1_1.31
 };
 
 const unsigned int DEFAULT_RENDERING_BACKEND = RENDERING_SHARED_ATLAS;
 
 } // namespace Text
 
+/**
+ * @}
+ */
 } // namespace Toolkit
 
 } // namespace Dali
 
-#endif // __DALI_TOOLKIT_RENDERING_BACKEND_H__
+#endif // DALI_TOOLKIT_RENDERING_BACKEND_H