[3.0] Add missed doxygen documentation

[platform/core/uifw/dali-adaptor.git] / adaptors / public-api / adaptor-framework / style-change.h

diff --git a/adaptors/public-api/adaptor-framework/style-change.h b/adaptors/public-api/adaptor-framework/style-change.h
index 5b5abf0..0cb0995 100644 (file)
--- a/adaptors/public-api/adaptor-framework/style-change.h
+++ b/adaptors/public-api/adaptor-framework/style-change.h
@@ -2,7 +2,7 @@
 #define __DALI_STYLE_CHANGE_H__
 
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2015 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.
@@ -19,39 +19,39 @@
  */
 
 // EXTERNAL INCLUDES
+#include <string>
 #include <dali/public-api/common/dali-common.h>
 
-namespace Dali DALI_IMPORT_API
+namespace Dali
 {
+/**
+ * @addtogroup dali_adaptor_framework
+ * @{
+ */
 
 /**
- * @brief Used to describe what style information has changed.
- *
- * This structure is used when any style changes occur and contains information about what exactly
- * has changed.
+ * @brief Style change information.
+ * @SINCE_1_0.0
+ */
+namespace StyleChange
+{
+
+/**
+ * @brief The type of StyleChange
+ * @SINCE_1_0.0
  */
-struct StyleChange
+enum Type
 {
-  // Data
-
-  bool defaultFontChange:1;     ///< Denotes that the default font has changed.
-  bool defaultFontSizeChange:1; ///< Denotes that the default font size has changed.
-  bool themeChange:1;           ///< Denotes that the theme has changed.
-  std::string themeFilePath;    ///< Contains the path to the new theme file.
-
-  // Construction
-
-  /**
-   * @brief Default Constructor.
-   */
-  StyleChange()
-  : defaultFontChange(false),
-    defaultFontSizeChange(false),
-    themeChange(false)
-  {
-  }
+  DEFAULT_FONT_CHANGE,      ///< Denotes that the default font has changed. @SINCE_1_0.0
+  DEFAULT_FONT_SIZE_CHANGE, ///< Denotes that the default font size has changed. @SINCE_1_0.0
+  THEME_CHANGE              ///< Denotes that the theme has changed. @SINCE_1_0.0
 };
 
+} // namespace StyleChange
+
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_STYLE_CHANGE_H__