[dali_2.3.24] Merge branch 'devel/master'

[platform/core/uifw/dali-toolkit.git] / dali-scene3d / public-api / loader / customization.h

diff --git a/dali-scene3d/public-api/loader/customization.h b/dali-scene3d/public-api/loader/customization.h
index 667cada..00f3082 100644 (file)
--- a/dali-scene3d/public-api/loader/customization.h
+++ b/dali-scene3d/public-api/loader/customization.h
@@ -1,7 +1,7 @@
 #ifndef DALI_SCENE3D_LOADER_CUSTOMIZATION_STATE_H_
 #define DALI_SCENE3D_LOADER_CUSTOMIZATION_STATE_H_
 /*
- * Copyright (c) 2022 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2023 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.
@@ -17,24 +17,21 @@
  *
  */
 
-// INTERNAL INCLUDES
-#include "dali-scene3d/public-api/api.h"
-
 // EXTERNAL INCLUDES
+#include <dali/public-api/common/vector-wrapper.h>
 #include <memory>
 #include <string>
-#include "dali/public-api/common/vector-wrapper.h"
 
-namespace Dali
-{
-namespace Scene3D
-{
-namespace Loader
+// INTERNAL INCLUDES
+#include <dali-scene3d/public-api/api.h>
+
+namespace Dali::Scene3D::Loader
 {
 /**
  * @brief Offers a description of an aspect of the scene that can be customized:
  *     the number of options, and the name of the nodes that are registered
  *     for the tag, whose children will be shown / hidden based on selection.
+ * @SINCE_2_0.7
  */
 struct DALI_SCENE3D_API Customization
 {
@@ -43,6 +40,7 @@ struct DALI_SCENE3D_API Customization
 
   /**
    * @brief A mapping of customizations to tags.
+   * @SINCE_2_0.7
    */
   struct DALI_SCENE3D_API Map
   {
@@ -51,27 +49,32 @@ struct DALI_SCENE3D_API Customization
 
     /**
      * @brief Maps the given @a customization to the given @a tag, overwriting any previous mapping to the same tag.
+     * @SINCE_2_0.7
      * @return Pointer to the inserted (or pre-existing) Customization instance.
      */
     Customization* Set(Tag tag, Customization&& customization);
 
     /**
      * @brief Attempts to retrieve a const Customization based on the given @a tag.
+     * @SINCE_2_0.7
      */
     const Customization* Get(Tag tag) const;
 
     /**
      * @brief Attempts to retrieve a Customization based on the given @a tag.
+     * @SINCE_2_0.7
      */
     Customization* Get(Tag tag);
 
     /**
      * @brief Returns the number of elements.
+     * @SINCE_2_0.7
      */
     uint32_t Size() const;
 
-    /*
+    /**
      * @brief Removes every element from the Map.
+     * @SINCE_2_0.7
      */
     void Clear();
 
@@ -82,6 +85,7 @@ struct DALI_SCENE3D_API Customization
 
   /**
    * @brief A mapping of choices - indices of children of customization nodes to use - to tags.
+   * @SINCE_2_0.7
    */
   struct DALI_SCENE3D_API Choices
   {
@@ -90,21 +94,28 @@ struct DALI_SCENE3D_API Customization
 
     /**
      * @brief Maps the given @a option to the given @a tag, overwriting any previous mapping to the same tag.
+     * @SINCE_2_0.7
      */
     void Set(Tag tag, OptionType option);
 
     /**
-     * @brief Attempts to retrieve a Customization based on the given @a tag. Returns NONE if @a tag is not known.
+     * @brief Attempts to retrieve a Customization based on the given @a tag.
+     * @SINCE_2_0.7
+     * @return A Customization based on the given @a tag.
+     * @note Returns NONE if @a tag is not known.
      */
     OptionType Get(Tag tag) const;
 
     /**
      * @brief Returns the number of elements.
+     * @SINCE_2_0.7
+     * @return The number of elements.
      */
     uint32_t Size() const;
 
-    /*
+    /**
      * @brief Removes every element from the underlying map.
+     * @SINCE_2_0.7
      */
     void Clear();
 
@@ -119,8 +130,6 @@ struct DALI_SCENE3D_API Customization
   std::vector<std::string> nodes; // to apply option to.
 };
 
-} // namespace Loader
-} // namespace Scene3D
-} // namespace Dali
+} // namespace Dali::Scene3D::Loader
 
 #endif //DALI_SCENE3D_LOADER_CUSTOMIZATION_STATE_H_