AssetManager - Comments added to the code.

* Doxygen comments added to the interface.
* Comments added to clarify the logic.

Change-Id: Ic707e12b4a479014bfdb9907b094a16fc33a734c
Signed-off-by: Victor Cebollada <v.cebollada@samsung.com>

diff --git a/dali-toolkit/devel-api/asset-manager/asset-manager.cpp b/dali-toolkit/devel-api/asset-manager/asset-manager.cpp
index b5c8662..b2427ec 100644 (file)
--- a/dali-toolkit/devel-api/asset-manager/asset-manager.cpp
+++ b/dali-toolkit/devel-api/asset-manager/asset-manager.cpp
@@ -36,26 +36,51 @@ namespace Toolkit
 
 const std::string AssetManager::GetDaliImagePath()
 {
+  /**
+   * @note DALI_IMAGE_DIR is a macro that can be defined either with a file system path or zero.
+   *       If it's defined as zero then the value is retrieved from an environment variable
+   *       named DALI_IMAGE_DIR.
+   */
   return (nullptr == DALI_IMAGE_DIR) ? EnvironmentVariable::GetEnvironmentVariable(TOKEN_STRING(DALI_IMAGE_DIR)) : DALI_IMAGE_DIR;
 }
 
 const std::string AssetManager::GetDaliSoundPath()
 {
+  /**
+   * @note DALI_SOUND_DIR is a macro that can be defined either with a file system path or zero.
+   *       If it's defined as zero then the value is retrieved from an environment variable
+   *       named DALI_SOUND_DIR.
+   */
   return (nullptr == DALI_SOUND_DIR) ? EnvironmentVariable::GetEnvironmentVariable(TOKEN_STRING(DALI_SOUND_DIR)) : DALI_SOUND_DIR;
 }
 
 const std::string AssetManager::GetDaliStylePath()
 {
+  /**
+   * @note DALI_STYLE_DIR is a macro that can be defined either with a file system path or zero.
+   *       If it's defined as zero then the value is retrieved from an environment variable
+   *       named DALI_STYLE_DIR.
+   */
   return (nullptr == DALI_STYLE_DIR) ? EnvironmentVariable::GetEnvironmentVariable(TOKEN_STRING(DALI_STYLE_DIR)) : DALI_STYLE_DIR;
 }
 
 const std::string AssetManager::GetDaliStyleImagePath()
 {
+  /**
+   * @note DALI_STYLE_IMAGE_DIR is a macro that can be defined either with a file system path or zero.
+   *       If it's defined as zero then the value is retrieved from an environment variable
+   *       named DALI_STYLE_IMAGE_DIR.
+   */
   return (nullptr == DALI_STYLE_IMAGE_DIR) ? EnvironmentVariable::GetEnvironmentVariable(TOKEN_STRING(DALI_STYLE_IMAGE_DIR)) : DALI_STYLE_IMAGE_DIR;
 }
 
 const std::string AssetManager::GetDaliDataReadOnlyPath()
 {
+  /**
+   * @note DALI_DATA_READ_ONLY_DIR is a macro that can be defined either with a file system path or zero.
+   *       If it's defined as zero then the value is retrieved from an environment variable
+   *       named DALI_DATA_READ_ONLY_DIR.
+   */
   return (nullptr == DALI_DATA_READ_ONLY_DIR) ? EnvironmentVariable::GetEnvironmentVariable(TOKEN_STRING(DALI_DATA_READ_ONLY_DIR)) : DALI_DATA_READ_ONLY_DIR;
 }
 

diff --git a/dali-toolkit/devel-api/asset-manager/asset-manager.h b/dali-toolkit/devel-api/asset-manager/asset-manager.h
index aa6f2d6..cba2ffd 100644 (file)
--- a/dali-toolkit/devel-api/asset-manager/asset-manager.h
+++ b/dali-toolkit/devel-api/asset-manager/asset-manager.h
@@ -29,13 +29,35 @@ namespace Dali
 namespace Toolkit
 {
 
+/**
+ * @brief Retrieves the file system path of the assets.
+ */
 class AssetManager
 {
 public:
+  /**
+   * @return The file system path of the images.
+   */
   static const std::string GetDaliImagePath();
+
+  /**
+   * @return The file system path of the sounds.
+   */
   static const std::string GetDaliSoundPath();
+
+  /**
+   * @return The file system path of the styles.
+   */
   static const std::string GetDaliStylePath();
+
+  /**
+   * @return The file system path of the images in the styles.
+   */
   static const std::string GetDaliStyleImagePath();
+
+  /**
+   * @return The file system path of the DALi's read only data.
+   */
   static const std::string GetDaliDataReadOnlyPath();
 };