Add internal tag to VectorAlgorithms
[platform/core/uifw/dali-core.git] / dali / public-api / common / type-traits.h
index 0d39201..bafc98c 100644 (file)
@@ -1,8 +1,8 @@
-#ifndef __DALI_TYPE_TRAITS_H__
-#define __DALI_TYPE_TRAITS_H__
+#ifndef DALI_TYPE_TRAITS_H
+#define DALI_TYPE_TRAITS_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.
 namespace Dali
 {
 /**
- * @addtogroup dali-core-common
+ * @addtogroup dali_core_common
  * @{
  */
 
 /**
- * @brief Basic type traits that every type has by default
- * This allows specialisations to not have to repeat all flags
+ * @brief Basic type traits that every type has by default.
+ *
+ * This allows specializations to not have to repeat all flags.
+ * @SINCE_1_0.0
  */
 template <typename Type>
 struct BasicTypes
 {
   /**
-   * This flag tells Dali if a class can be considered POD. If it declares copy constructor and/or destructor, its not considered trivial
+   * @brief This flag tells Dali if a class can be considered POD.
+   *
+   * If it declares copy constructor and/or destructor, its not considered trivial
    * and cannot be copied by using memcpy etc.
+   * @SINCE_1_0.0
    */
   enum { IS_TRIVIAL_TYPE = __has_trivial_destructor(Type) && __has_trivial_copy(Type) };
 };
 
 /**
- * @brief Type traits support
+ * @brief Type traits.
+ *
  * An example of overriding a traits flag for a custom type can be done by:
- * <code>
+ *
+ * @code
+ *
  * namespace Dali
  * {
- *   /// Tell DALi that Matrix is POD, even though it has a copy constructor
- *   template <> struct TypeTraits< Matrix > : public BasicTypes< Matrix > { enum { IS_TRIVIAL_TYPE = true }; };
+ *   /// Tell DALi that Dali::Matrix is POD, even though it has a copy constructor
+ *   template <> struct TypeTraits< Dali::Matrix > : public BasicTypes< Dali::Matrix > { enum { IS_TRIVIAL_TYPE = true }; };
  * }
- * </code>
+ *
+ * @endcode
+ *
+ * @SINCE_1_0.0
  */
 template <typename Type>
 struct TypeTraits : public BasicTypes< Type >
@@ -60,4 +71,4 @@ struct TypeTraits : public BasicTypes< Type >
  */
 } // namespace Dali
 
-#endif /* __DALI_TYPE_TRAITS_H__ */
+#endif // DALI_TYPE_TRAITS_H