Merge branch 'devel/master' into tizen

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

diff --git a/dali-scene3d/public-api/loader/model-loader.h b/dali-scene3d/public-api/loader/model-loader.h
index 7cec995..8a660de 100644 (file)
--- a/dali-scene3d/public-api/loader/model-loader.h
+++ b/dali-scene3d/public-api/loader/model-loader.h
@@ -25,11 +25,7 @@
 // EXTERNAL INCLUDES
 #include <string>
 
-namespace Dali
-{
-namespace Scene3D
-{
-namespace Loader
+namespace Dali::Scene3D::Loader
 {
 namespace Internal
 {
@@ -45,6 +41,7 @@ public:
 
   /**
    * @brief ModelLoader Constructor.
+   * @SINCE_2_2.17
    * @param[in] modelUrl Url of the model file to be loaded
    * @param[in] resourceDirectoryUrl Url of directory that contains resources.
    * @param[out] loadResult Loaded result that includes scene tree and resources.
@@ -53,6 +50,7 @@ public:
 
   /**
    * @brief Request to load model from model url.
+   * @SINCE_2_2.17
    * @param[in] pathProvider Path provider that defines resource paths.
    * @param[in] loadOnlyRawResource If true, load Raw resource only, and do not create Dali::Handle
    * If false, this loader load Raw resource and create Dali::Handle too.
@@ -63,38 +61,45 @@ public:
 
   /**
    * @brief Set InputParameter.
-   * Thie method store only a pointer of InputParameter.
+   *
+   * This method store only a pointer of InputParameter.
    * The object of InputParameter should not be deleted until it is no longer used.
+   * @SINCE_2_2.17
    * @param[in] inputParameter Input parameters that can be used in loading time.
    */
   void SetInputParameter(InputParameter& inputParameter);
 
   /**
-   * @brief Retrieves loaded scene
+   * @brief Retrieves loaded scene.
+   * @SINCE_2_2.17
    * @return SceneDefinition that is loaded from file
    */
   Dali::Scene3D::Loader::SceneDefinition& GetScene();
 
   /**
-   * @brief Retrieves resource bundle that includes resource information
+   * @brief Retrieves resource bundle that includes resource information.
+   * @SINCE_2_2.17
    * @return ResourceBundle for model resources
    */
   Dali::Scene3D::Loader::ResourceBundle& GetResources();
 
   /**
-   * @brief Retrieves loaded AnimationDefinition
+   * @brief Retrieves loaded AnimationDefinition.
+   * @SINCE_2_2.17
    * @return AnimationDefinition that is loaded from file
    */
   std::vector<Dali::Scene3D::Loader::AnimationDefinition>& GetAnimations();
 
   /**
-   * @brief Retrieves loaded CameraParameters
+   * @brief Retrieves loaded CameraParameters.
+   * @SINCE_2_2.17
    * @return CameraParameters list that is loaded from file
    */
   std::vector<Dali::Scene3D::Loader::CameraParameters>& GetCameras();
 
   /**
-   * @brief Retrieves ResourceChoices
+   * @brief Retrieves ResourceChoices.
+   * @SINCE_2_2.17
    * @return Choices for loaded Resources
    */
   Dali::Scene3D::Loader::Customization::Choices& GetResourceChoices();
@@ -102,11 +107,13 @@ public:
 private:
   /**
    * @brief Create model loader for each file format.
+   * @SINCE_2_2.17
    */
   void CreateModelLoader();
 
   /**
    * @brief Load resource of the model.
+   * @SINCE_2_2.17
    */
   void LoadResource(Dali::Scene3D::Loader::ResourceBundle::PathProvider& pathProvider, bool loadOnlyRawResource);
 
@@ -119,8 +126,6 @@ private:
 
   std::shared_ptr<Internal::ModelLoaderImpl> mImpl;
 };
-} // namespace Loader
-} // namespace Scene3D
-} // namespace Dali
+} // namespace Dali::Scene3D::Loader
 
 #endif // DALI_SCENE3D_LOADER_MODEL_LOADER_H