[3.0] Add missed doxygen documentation

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

diff --git a/dali/public-api/object/property-array.h b/dali/public-api/object/property-array.h
index 69e6967..790043b 100644 (file)
--- a/dali/public-api/object/property-array.h
+++ b/dali/public-api/object/property-array.h
@@ -35,6 +35,7 @@ namespace Dali
 
 /**
  * @brief A Array of property values.
+ * @SINCE_1_0.0
  */
 class DALI_IMPORT_API Property::Array
 {
@@ -44,24 +45,28 @@ public:
 
   /**
    * @brief Default constructor.
+   * @SINCE_1_0.0
    */
   Array();
 
   /**
    * @brief Copy Constructor.
    *
+   * @SINCE_1_0.0
    * @param[in] other The Array to copy from.
    */
   Array( const Array& other );
 
   /**
    * @brief Non-virtual destructor.
+   * @SINCE_1_0.0
    */
   ~Array();
 
   /**
    * @brief Retrieve the number of elements in the array.
    *
+   * @SINCE_1_0.0
    * @return The number of elements in the array.
    */
   SizeType Size() const
@@ -72,6 +77,7 @@ public:
   /**
    * @brief Retrieve the number of elements in the array.
    *
+   * @SINCE_1_0.0
    * @return The number of elements in the array.
    */
   SizeType Count() const;
@@ -79,6 +85,7 @@ public:
   /**
    * @brief Returns whether the array is empty.
    *
+   * @SINCE_1_0.0
    * @return true if empty, false otherwise
    */
   bool Empty() const
@@ -88,22 +95,28 @@ public:
 
   /**
    * @brief Clears the array.
+   * @SINCE_1_0.0
    */
   void Clear();
 
   /**
    * @brief Increase the capcity of the array.
+   * @SINCE_1_0.0
+   * @param[in] size The size to reserve
    */
   void Reserve( SizeType size );
 
   /**
    * @brief Resize to size.
+   * @SINCE_1_0.0
+   * @param[in] size The size to resize
    */
   void Resize( SizeType size );
 
   /**
    * @brief Retrieve the capacity of the array.
    *
+   * @SINCE_1_0.0
    * @return The allocated capacity of the array
    */
   SizeType Capacity();
@@ -111,6 +124,7 @@ public:
   /**
    * @brief Add an element to the array.
    *
+   * @SINCE_1_0.0
    * @param[in] value The value to add to the end of the array
    */
   void PushBack( const Value& value );
@@ -118,6 +132,7 @@ public:
   /**
    * @brief Const access an element.
    *
+   * @SINCE_1_0.0
    * @param[in] index The element index to access. No bounds checking is performed.
    *
    * @return The a reference to the element.
@@ -130,6 +145,7 @@ public:
   /**
    * @brief Access an element.
    *
+   * @SINCE_1_0.0
    * @param[in] index The element index to access. No bounds checking is performed.
    *
    * @return The a reference to the element.
@@ -142,6 +158,7 @@ public:
   /**
    * @brief Const operator to access an element.
    *
+   * @SINCE_1_0.0
    * @param[in] index The element index to access. No bounds checking is performed.
    *
    * @return The a reference to the element.
@@ -152,6 +169,7 @@ public:
   /**
    * @brief Operator to access an element.
    *
+   * @SINCE_1_0.0
    * @param[in] index The element index to access. No bounds checking is performed.
    *
    * @return The a reference to the element.
@@ -162,18 +180,35 @@ public:
   /**
    * @brief Assignment Operator
    *
+   * @SINCE_1_0.0
    * @param[in] other The array to copy from.
    *
    * @return The copied array.
    */
   Array& operator=( const Array& other );
 
+  /**
+   * @brief output to stream
+   * @SINCE_1_1.28
+   */
+  friend std::ostream& operator<<( std::ostream& stream, const Property::Array& array );
+
 private:
   struct DALI_INTERNAL Impl; ///< Private data
   Impl* mImpl; ///< Pointer to private data
 };
 
 /**
+ * @brief Convert the values of the property array into a string and append to an output stream.
+ *
+ * @SINCE_1_1.28
+ * @param [in] stream The output stream operator.
+ * @param [in] array The array to insert
+ * @return The output stream operator.
+ */
+DALI_IMPORT_API std::ostream& operator<<( std::ostream& stream, const Property::Array& array );
+
+/**
  * @}
  */
 } // namespace Dali