Revert "[3.0] Exclude internal tag module in Public API reference"

[platform/core/uifw/dali-core.git] / dali / public-api / object / property-value.h

diff --git a/dali/public-api/object/property-value.h b/dali/public-api/object/property-value.h
index 3e93d2f..8ebab5a 100644 (file)
--- a/dali/public-api/object/property-value.h
+++ b/dali/public-api/object/property-value.h
@@ -2,7 +2,7 @@
 #define __DALI_PROPERTY_VALUE_H__
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2016 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.
@@ -27,6 +27,10 @@
 
 namespace Dali
 {
+/**
+ * @addtogroup dali_core_object
+ * @{
+ */
 
 struct AngleAxis;
 class Quaternion;
@@ -38,6 +42,7 @@ class Matrix;
 
 /**
  * @brief A value-type representing a property value.
+ * @SINCE_1_0.0
  */
 class DALI_IMPORT_API Property::Value
 {
@@ -47,12 +52,14 @@ public:
    * @brief Default constructor.
    *
    * This creates a property with type Property::NONE.
+   * @SINCE_1_0.0
    */
   Value();
 
   /**
    * @brief Create a boolean property value.
    *
+   * @SINCE_1_0.0
    * @param [in] boolValue A boolean value.
    */
   Value( bool boolValue );
@@ -60,6 +67,7 @@ public:
   /**
    * @brief Create an integer property value.
    *
+   * @SINCE_1_0.0
    * @param [in] integerValue An integer value.
    */
   Value( int integerValue );
@@ -67,6 +75,7 @@ public:
   /**
    * @brief Create a float property value.
    *
+   * @SINCE_1_0.0
    * @param [in] floatValue A floating-point value.
    */
   Value( float floatValue );
@@ -74,6 +83,7 @@ public:
   /**
    * @brief Create a Vector2 property value.
    *
+   * @SINCE_1_0.0
    * @param [in] vectorValue A vector of 2 floating-point values.
    */
   Value( const Vector2& vectorValue );
@@ -81,6 +91,7 @@ public:
   /**
    * @brief Create a Vector3 property value.
    *
+   * @SINCE_1_0.0
    * @param [in] vectorValue A vector of 3 floating-point values.
    */
   Value( const Vector3& vectorValue );
@@ -88,6 +99,7 @@ public:
   /**
    * @brief Create a Vector4 property value.
    *
+   * @SINCE_1_0.0
    * @param [in] vectorValue A vector of 4 floating-point values.
    */
   Value( const Vector4& vectorValue );
@@ -95,6 +107,7 @@ public:
   /**
    * @brief Create a Matrix3 property value.
    *
+   * @SINCE_1_0.0
    * @param [in] matrixValue A matrix of 3x3 floating-point values.
    */
   Value( const Matrix3& matrixValue );
@@ -102,6 +115,7 @@ public:
   /**
    * @brief Create a Matrix property value.
    *
+   * @SINCE_1_0.0
    * @param [in] matrixValue A matrix of 4x4 floating-point values.
    */
   Value( const Matrix& matrixValue );
@@ -109,6 +123,7 @@ public:
   /**
    * @brief Create a Vector4 property value.
    *
+   * @SINCE_1_0.0
    * @param [in] vectorValue A vector of 4 integer values.
    */
   Value( const Rect<int>& vectorValue );
@@ -116,6 +131,7 @@ public:
   /**
    * @brief Create an orientation property value.
    *
+   * @SINCE_1_0.0
    * @param [in] angleAxis An angle-axis representing the rotation.
    */
   Value( const AngleAxis& angleAxis );
@@ -123,6 +139,7 @@ public:
   /**
    * @brief Create an orientation property value.
    *
+   * @SINCE_1_0.0
    * @param [in] quaternion A quaternion representing the rotation.
    */
   Value( const Quaternion& quaternion );
@@ -130,6 +147,7 @@ public:
   /**
    * @brief Create an string property value.
    *
+   * @SINCE_1_0.0
    * @param [in] stringValue A string.
    */
   Value( const std::string& stringValue );
@@ -137,6 +155,7 @@ public:
   /**
    * @brief Create an string property value.
    *
+   * @SINCE_1_0.0
    * @param [in] stringValue A string.
    */
   Value( const char* stringValue );
@@ -144,6 +163,7 @@ public:
   /**
    * @brief Create an array property value.
    *
+   * @SINCE_1_0.0
    * @param [in] arrayValue An array
    */
   Value( Property::Array& arrayValue );
@@ -151,6 +171,7 @@ public:
   /**
    * @brief Create a map property value.
    *
+   * @SINCE_1_0.0
    * @param [in] mapValue An array
    */
   Value( Property::Map& mapValue );
@@ -158,6 +179,7 @@ public:
   /**
    * @brief Explicitly set a type and initialize it.
    *
+   * @SINCE_1_0.0
    * @param [in] type The property value type.
    */
   explicit Value( Type type );
@@ -165,6 +187,7 @@ public:
   /**
    * @brief Copy constructor
    *
+   * @SINCE_1_0.0
    * @param [in] value The property value to copy.
    */
   Value( const Value& value );
@@ -172,6 +195,7 @@ public:
   /**
    * @brief Assign a property value.
    *
+   * @SINCE_1_0.0
    * @param [in] value The property value to assign from.
    * @return a reference to this
    */
@@ -181,12 +205,14 @@ public:
    * @brief Non-virtual destructor.
    *
    * This class is not a base class.
+   * @SINCE_1_0.0
    */
   ~Value();
 
   /**
    * @brief Query the type of this property value.
    *
+   * @SINCE_1_0.0
    * @return The type ID.
    */
   Type GetType() const;
@@ -196,6 +222,7 @@ public:
    *
    * Works on a best-effort approach; if value type is not convertible returns a default value of the type
    *
+   * @SINCE_1_0.0
    * @return A value of type T.
    */
   template <typename T>
@@ -209,132 +236,147 @@ public:
   /**
    * @brief Retrieve a boolean value.
    *
-   * @pre GetType() returns Property::BOOLEAN.
+   * @SINCE_1_0.0
    * @param [out] boolValue On return, a boolean value.
    * @return true if the value is successfully retrieved, false if the type is not convertible
+   * @pre GetType() is a type convertible to bool.
    */
   bool Get( bool& boolValue ) const;
 
   /**
    * @brief Retrieve a floating-point value.
    *
-   * @pre GetType() returns Property::FLOAT.
+   * @SINCE_1_0.0
    * @param [out] floatValue On return, a floating-point value.
    * @return true if the value is successfully retrieved, false if the type is not convertible
+   * @pre GetType() is a type convertible to float.
    */
   bool Get( float& floatValue ) const;
 
   /**
    * @brief Retrieve an integer value.
    *
-   * @pre GetType() returns Property::INTEGER.
+   * @SINCE_1_0.0
    * @param [out] integerValue On return, an integer value.
    * @return true if the value is successfully retrieved, false if the type is not convertible
+   * @pre GetType() is a type convertible to int.
    */
   bool Get( int& integerValue ) const;
 
   /**
    * @brief Retrieve an integer rectangle.
    *
-   * @pre GetType() returns Property::RECTANGLE.
+   * @SINCE_1_0.0
    * @param [out] rect On return, an integer rectangle.
    * @return true if the value is successfully retrieved, false if the type is not convertible
+   * @pre GetType() is a type convertible to Rect<int>.
    */
   bool Get( Rect<int>& rect ) const;
 
   /**
    * @brief Retrieve a vector value.
    *
-   * @pre GetType() returns Property::VECTOR2.
+   * @SINCE_1_0.0
    * @param [out] vectorValue On return, a vector value.
    * @return true if the value is successfully retrieved, false if the type is not convertible
+   * @pre GetType() is a type convertible to Vector2.
    */
   bool Get( Vector2& vectorValue ) const;
 
   /**
    * @brief Retrieve a vector value.
    *
-   * @pre GetType() returns Property::VECTOR3.
+   * @SINCE_1_0.0
    * @param [out] vectorValue On return, a vector value.
    * @return true if the value is successfully retrieved, false if the type is not convertible
+   * @pre GetType() is a type convertible to Vector3.
    */
   bool Get( Vector3& vectorValue ) const;
 
   /**
    * @brief Retrieve a vector value.
    *
-   * @pre GetType() returns Property::VECTOR4.
+   * @SINCE_1_0.0
    * @param [out] vectorValue On return, a vector value.
    * @return true if the value is successfully retrieved, false if the type is not convertible
+   * @pre GetType() is a type convertible to Vector4.
    */
   bool Get( Vector4& vectorValue ) const;
 
   /**
    * @brief Retrieve a matrix3 value.
    *
-   * @pre GetType() returns Property::MATRIX3.
+   * @SINCE_1_0.0
    * @param [out] matrixValue On return, a matrix3 value.
    * @return true if the value is successfully retrieved, false if the type is not convertible
+   * @pre GetType() is a type convertible to Matrix3.
    */
   bool Get( Matrix3& matrixValue ) const;
 
   /**
    * @brief Retrieve a matrix value.
    *
-   * @pre GetType() returns Property::MATRIX.
+   * @SINCE_1_0.0
    * @param [out] matrixValue On return, a matrix value.
    * @return true if the value is successfully retrieved, false if the type is not convertible
+   * @pre GetType() is a type convertible to Matrix.
    */
   bool Get( Matrix& matrixValue ) const;
 
   /**
    * @brief Retrieve an angle-axis value.
    *
-   * @pre GetType() returns Property::ROTATION.
+   * @SINCE_1_0.0
    * @param [out] angleAxisValue On return, a angle-axis value.
    * @return true if the value is successfully retrieved, false if the type is not convertible
+   * @pre GetType() is a type convertible to AngleAxis.
    */
   bool Get( AngleAxis& angleAxisValue ) const;
 
   /**
    * @brief Retrieve a quaternion value.
    *
-   * @pre GetType() returns Property::ROTATION.
+   * @SINCE_1_0.0
    * @param [out] quaternionValue On return, a quaternion value.
    * @return true if the value is successfully retrieved, false if the type is not convertible
+   * @pre GetType() is a type convertible to Quaternion.
    */
   bool Get( Quaternion& quaternionValue ) const;
 
   /**
    * @brief Retrieve an string property value.
    *
-   * @pre GetType() returns Property::STRING.
+   * @SINCE_1_0.0
    * @param [out] stringValue A string.
    * @return true if the value is successfully retrieved, false if the type is not convertible
+   * @pre GetType() is a type convertible to string.
    */
   bool Get( std::string& stringValue ) const;
 
   /**
    * @brief Retrieve an array property value.
    *
-   * @pre GetType() returns Property::ARRAY.
+   * @SINCE_1_0.0
    * @param [out] arrayValue The array as a vector Property Values
    * @return true if the value is successfully retrieved, false if the type is not convertible
+   * @pre GetType() returns Property::ARRAY.
    */
   bool Get( Property::Array& arrayValue ) const;
 
   /**
    * @brief Retrieve an map property value.
    *
-   * @pre GetType() returns Property::MAP.
+   * @SINCE_1_0.0
    * @param [out] mapValue The map as vector of string and Property Value pairs
    * @return true if the value is successfully retrieved, false if the type is not convertible
+   * @pre GetType() returns Property::MAP.
    */
   bool Get( Property::Map& mapValue ) const;
 
   /**
    * @brief Retrieve the Array API of the Property::Value without copying the contents of the map
    *
+   * @SINCE_1_0.0
    * @return the Array API of the Property::Value or NULL if not a Property::Array
    */
   Property::Array* GetArray() const;
@@ -342,12 +384,14 @@ public:
   /**
    * @brief Retrieve the Map API of the Property::Value without copying the contents of the map
    *
+   * @SINCE_1_0.0
    * @return  the Map API of the Property::Value or NULL if not a Property::Map
    */
   Property::Map* GetMap() const;
 
   /**
-   * output to stream
+   * @brief output to stream
+   * @SINCE_1_0.0
    */
   friend std::ostream& operator<<( std::ostream& ouputStream, const Property::Value& value );
 
@@ -361,12 +405,16 @@ private:
 /**
  * @brief Convert the value of the property into a string and append to an output stream.
  *
+ * @SINCE_1_0.0
  * @param [in] ouputStream The output stream operator.
  * @param [in] value The value to insert
  * @return The output stream operator.
  */
 DALI_IMPORT_API std::ostream& operator<<( std::ostream& ouputStream, const Property::Value& value );
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PROPERTY_VALUE_H__