X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fobject%2Fproperty-array.h;h=43d399f96e740d4abdb4657ce19dc3c6fd791e02;hb=refs%2Fchanges%2F57%2F114957%2F2;hp=d2ffa7ae9bc23ec960efcc925e6301d71057a798;hpb=460928bcc2c3825836f1dfdacd59dc73b39b98d3;p=platform%2Fcore%2Fuifw%2Fdali-core.git

diff --git a/dali/public-api/object/property-array.h b/dali/public-api/object/property-array.h
index d2ffa7a..43d399f 100644
--- a/dali/public-api/object/property-array.h
+++ b/dali/public-api/object/property-array.h
@@ -53,7 +53,7 @@ public:
    * @brief Copy Constructor.
    *
    * @SINCE_1_0.0
-   * @param[in] other The Array to copy from.
+   * @param[in] other The Array to copy from
    */
   Array( const Array& other );
 
@@ -64,10 +64,10 @@ public:
   ~Array();
 
   /**
-   * @brief Retrieve the number of elements in the array.
+   * @brief Retrieves the number of elements in the array.
    *
    * @SINCE_1_0.0
-   * @return The number of elements in the array.
+   * @return The number of elements in the array
    */
   SizeType Size() const
   {
@@ -75,10 +75,10 @@ public:
   }
 
   /**
-   * @brief Retrieve the number of elements in the array.
+   * @brief Retrieves the number of elements in the array.
    *
    * @SINCE_1_0.0
-   * @return The number of elements in the array.
+   * @return The number of elements in the array
    */
   SizeType Count() const;
 
@@ -86,7 +86,7 @@ public:
    * @brief Returns whether the array is empty.
    *
    * @SINCE_1_0.0
-   * @return true if empty, false otherwise
+   * @return @c true if empty, @c false otherwise
    */
   bool Empty() const
   {
@@ -100,19 +100,21 @@ public:
   void Clear();
 
   /**
-   * @brief Increase the capcity of the array.
+   * @brief Increases the capacity of the array.
    * @SINCE_1_0.0
+   * @param[in] size The size to reserve
    */
   void Reserve( SizeType size );
 
   /**
-   * @brief Resize to size.
+   * @brief Resizes to size.
    * @SINCE_1_0.0
+   * @param[in] size The size to resize
    */
   void Resize( SizeType size );
 
   /**
-   * @brief Retrieve the capacity of the array.
+   * @brief Retrieves the capacity of the array.
    *
    * @SINCE_1_0.0
    * @return The allocated capacity of the array
@@ -120,7 +122,7 @@ public:
   SizeType Capacity();
 
   /**
-   * @brief Add an element to the array.
+   * @brief Adds an element to the array.
    *
    * @SINCE_1_0.0
    * @param[in] value The value to add to the end of the array
@@ -131,9 +133,8 @@ 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.
+   * @param[in] index The element index to access. No bounds checking is performed
+   * @return The a reference to the element
    */
   const Value& GetElementAt( SizeType index ) const
   {
@@ -141,12 +142,11 @@ public:
   }
 
   /**
-   * @brief Access an element.
+   * @brief Accesses 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.
+   * @param[in] index The element index to access. No bounds checking is performed
+   * @return The a reference to the element
    */
   Value& GetElementAt( SizeType index )
   {
@@ -157,9 +157,8 @@ 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.
+   * @param[in] index The element index to access. No bounds checking is performed
+   * @return The a reference to the element
    *
    */
   const Value& operator[]( SizeType index ) const;
@@ -168,25 +167,24 @@ 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.
+   * @param[in] index The element index to access. No bounds checking is performed
+   * @return The a reference to the element
    *
    */
   Value& operator[]( SizeType index );
 
   /**
-   * @brief Assignment Operator
+   * @brief Assignment Operator.
    *
    * @SINCE_1_0.0
-   * @param[in] other The array to copy from.
+   * @param[in] other The array to copy from
    *
    * @return The copied array.
    */
   Array& operator=( const Array& other );
 
   /**
-   * @brief output to stream
+   * @brief Output to stream.
    * @SINCE_1_1.28
    */
   friend std::ostream& operator<<( std::ostream& stream, const Property::Array& array );
@@ -197,12 +195,12 @@ private:
 };
 
 /**
- * @brief Convert the values of the property array into a string and append to an output stream.
+ * @brief Converts 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.
+ * @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 );