[3.0] Update doxygen tags

- @returns -> @return / @param -> @param[in] / @detail descriptions

Change-Id: I5ae9f7849030988748f0afb4ce58f7b4b06ed7ab
Signed-off-by: Seoyeon Kim <seoyeon2.kim@samsung.com>

diff --git a/dali/public-api/actors/actor.h b/dali/public-api/actors/actor.h
index b36b899..e77c6f8 100644 (file)
--- a/dali/public-api/actors/actor.h
+++ b/dali/public-api/actors/actor.h
@@ -1300,7 +1300,7 @@ public:
    * size 0 is treated as aspect ratio 1:1.
    *
    * @SINCE_1_0.0
-   * @param width Width to use
+   * @param[in] width Width to use
    * @return Return the height based on the width.
    */
   float GetHeightForWidth( float width );
@@ -1312,7 +1312,7 @@ public:
    * size 0 is treated as aspect ratio 1:1.
    *
    * @SINCE_1_0.0
-   * @param height Height to use
+   * @param[in] height Height to use
    * @return Return the width based on the height.
    */
   float GetWidthForHeight( float height );
@@ -1321,7 +1321,7 @@ public:
    * @brief Return the value of negotiated dimension for the given dimension.
    *
    * @SINCE_1_0.0
-   * @param dimension The dimension to retrieve
+   * @param[in] dimension The dimension to retrieve
    * @return Return the value of the negotiated dimension. If more than one dimension is requested, just return the first one found.
    */
   float GetRelayoutSize( Dimension::Type dimension ) const;
@@ -1338,7 +1338,7 @@ public:
    * @brief Return the value of the padding.
    *
    * @SINCE_1_0.0
-   * @param paddingOut The returned padding data
+   * @param[in] paddingOut The returned padding data
    */
   void GetPadding( Padding& paddingOut ) const;
 

diff --git a/dali/public-api/actors/custom-actor-impl.h b/dali/public-api/actors/custom-actor-impl.h
index cf40733..8335aeb 100644 (file)
--- a/dali/public-api/actors/custom-actor-impl.h
+++ b/dali/public-api/actors/custom-actor-impl.h
@@ -264,7 +264,7 @@ public:
    * Derived classes should override this if they wish to customize the height returned.
    *
    * @SINCE_1_0.0
-   * @param width Width to use.
+   * @param[in] width Width to use.
    * @return The height based on the width.
    */
   virtual float GetHeightForWidth( float width ) = 0;
@@ -275,7 +275,7 @@ public:
    * Derived classes should override this if they wish to customize the width returned.
    *
    * @SINCE_1_0.0
-   * @param height Height to use.
+   * @param[in] height Height to use.
    * @return The width based on the width.
    */
   virtual float GetWidthForHeight( float height ) = 0;
@@ -284,7 +284,7 @@ public:
    * @brief Determine if this actor is dependent on it's children for relayout.
    *
    * @SINCE_1_0.0
-   * @param dimension The dimension(s) to check for
+   * @param[in] dimension The dimension(s) to check for
    * @return Return if the actor is dependent on it's children.
    */
   virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) = 0;
@@ -294,7 +294,7 @@ public:
    * met and the size for this object is about to be calculated for the given dimension
    *
    * @SINCE_1_0.0
-   * @param dimension The dimension that is about to be calculated
+   * @param[in] dimension The dimension that is about to be calculated
    */
   virtual void OnCalculateRelayoutSize( Dimension::Type dimension ) = 0;
 
@@ -364,7 +364,7 @@ protected: // For derived classes
   /**
    * @brief Provides the Actor implementation of GetHeightForWidth.
    * @SINCE_1_0.0
-   * @param width Width to use.
+   * @param[in] width Width to use.
    * @return The height based on the width.
    */
   float GetHeightForWidthBase( float width );
@@ -372,7 +372,7 @@ protected: // For derived classes
   /**
    * @brief Provides the Actor implementation of GetWidthForHeight.
    * @SINCE_1_0.0
-   * @param height Height to use.
+   * @param[in] height Height to use.
    * @return The width based on the height.
    */
   float GetWidthForHeightBase( float height );
@@ -391,7 +391,7 @@ protected: // For derived classes
    * @brief Determine if this actor is dependent on it's children for relayout from the base class.
    *
    * @SINCE_1_0.0
-   * @param dimension The dimension(s) to check for
+   * @param[in] dimension The dimension(s) to check for
    * @return Return if the actor is dependent on it's children.
    */
   bool RelayoutDependentOnChildrenBase( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );

diff --git a/dali/public-api/common/dali-vector.h b/dali/public-api/common/dali-vector.h
index 83a2df6..fa39023 100644 (file)
--- a/dali/public-api/common/dali-vector.h
+++ b/dali/public-api/common/dali-vector.h
@@ -504,7 +504,7 @@ public: // API
   /**
    * @brief Subscript operator.
    * @SINCE_1_0.0
-   * @param[in]  index of the element.
+   * @param[in] index Index of the element.
    * @return reference to the element for given index.
    * @pre index must be in the vector's range.
    */

diff --git a/dali/public-api/events/tap-gesture.h b/dali/public-api/events/tap-gesture.h
index 0f8645d..0107205 100644 (file)
--- a/dali/public-api/events/tap-gesture.h
+++ b/dali/public-api/events/tap-gesture.h
@@ -49,14 +49,14 @@ struct DALI_IMPORT_API TapGesture : public Gesture
   /**
    * @brief Copy constructor
    * @SINCE_1_0.0
-   * @param rhs A reference to the copied handle
+   * @param[in] rhs A reference to the copied handle
    */
   TapGesture( const TapGesture& rhs );
 
   /**
    * @brief Assignment operator
    * @SINCE_1_0.0
-   * @param rhs A reference to the copied handle
+   * @param[in] rhs A reference to the copied handle
    * @return A reference to this
    */
   TapGesture& operator=( const TapGesture& rhs );

diff --git a/dali/public-api/images/pixel-data.h b/dali/public-api/images/pixel-data.h
index b75a4e5..8f8f592 100644 (file)
--- a/dali/public-api/images/pixel-data.h
+++ b/dali/public-api/images/pixel-data.h
@@ -78,7 +78,7 @@ public:
   PixelData();
 
   /**
-   * Destructor
+   * @brief Destructor.
    *
    * @SINCE_1_1.43
    */
@@ -102,7 +102,7 @@ public:
   PixelData& operator=(const PixelData& rhs);
 
   /**
-   * Get the width of the buffer in pixels.
+   * @brief Get the width of the buffer in pixels.
    *
    * @SINCE_1_1.43
    * @return The width of the buffer in pixels
@@ -110,7 +110,7 @@ public:
   unsigned int GetWidth() const;
 
   /**
-   * Get the height of the buffer in pixels
+   * @brief Get the height of the buffer in pixels.
    *
    * @SINCE_1_1.43
    * @return The height of the buffer in pixels
@@ -118,7 +118,7 @@ public:
   unsigned int GetHeight() const;
 
   /**
-   * Get the pixel format
+   * @brief Get the pixel format.
    *
    * @SINCE_1_1.43
    * @return The pixel format

diff --git a/dali/public-api/math/uint-16-pair.h b/dali/public-api/math/uint-16-pair.h
index ead729a..2cb3846 100644 (file)
--- a/dali/public-api/math/uint-16-pair.h
+++ b/dali/public-api/math/uint-16-pair.h
@@ -91,8 +91,9 @@ public:
   }
 
   /**
-   * @brief @returns the x dimension stored in this 2-tuple.
+   * @brief Get the width.
    * @SINCE_1_0.0
+   * @return the x dimension stored in this 2-tuple
    */
   uint16_t GetWidth() const
   {

diff --git a/dali/public-api/object/any.h b/dali/public-api/object/any.h
index 8e77c77..67cd73f 100644 (file)
--- a/dali/public-api/object/any.h
+++ b/dali/public-api/object/any.h
@@ -65,7 +65,7 @@ public:
    * @brief Pass Assert message
    *
    * @SINCE_1_0.0
-   * @param assertMessage Assert message to report
+   * @param[in] assertMessage Assert message to report
    */
   DALI_IMPORT_API static void AssertAlways( const char* assertMessage );
 
@@ -84,7 +84,7 @@ public:
   /**
    * @brief Copy Constructor.
    * @SINCE_1_0.0
-   * @param [in] any Any to be copied.
+   * @param[in] any Any to be copied.
    */
   Any( const Any& any )
   {
@@ -150,7 +150,7 @@ public:
    * @brief Get a value of type Type from container
    *
    * @SINCE_1_0.0
-   * @param type destination of type Type to write to
+   * @param[in] type destination of type Type to write to
    */
   template<typename Type>
   void Get( Type& type ) const
@@ -258,9 +258,9 @@ public:
      * @brief Constructor of base container
      *
      * @SINCE_1_0.0
-     * @param type typeid of container
-     * @param cloneFunc Cloning function to replicate this container type
-     * @param deleteFunc Deleting function to destroy this container type
+     * @param[in] type typeid of container
+     * @param[in] cloneFunc Cloning function to replicate this container type
+     * @param[in] deleteFunc Deleting function to destroy this container type
      */
     AnyContainerBase( const std::type_info& type, CloneFunc cloneFunc, DeleteFunc deleteFunc )
     : mType( type ),
@@ -289,7 +289,7 @@ public:
    * @brief Templated Clone function from container base
    *
    * @SINCE_1_0.0
-   * @param base reference to container
+   * @param[in] base reference to container
    */
   template<typename Type>
   struct AnyContainerImplCloner
@@ -304,7 +304,7 @@ public:
    * @brief Templated Delete function from container base
    *
    * @SINCE_1_0.0
-   * @param base pointer to container
+   * @param[in] base pointer to container
    */
   template<typename Type>
   struct AnyContainerImplDelete
@@ -329,7 +329,7 @@ public:
      * @brief Constructor to create container holding value of type Type
      *
      * @SINCE_1_0.0
-     * @param value Value of Type
+     * @param[in] value Value of Type
      */
     AnyContainerImpl( const Type& value )
     : AnyContainerBase( typeid( Type ),
@@ -342,7 +342,7 @@ public:
      * @brief Constructor to create new container of type from and existing container (cloning)
      *
      * @SINCE_1_0.0
-     * @param base reference to base container to copy from
+     * @param[in] base reference to base container to copy from
      */
     AnyContainerImpl( const AnyContainerBase& base )
     : AnyContainerBase( typeid( Type ),
@@ -367,7 +367,7 @@ public:
      * @brief Set the container's stored value
      *
      * @SINCE_1_0.0
-     * @param value of type Type
+     * @param[in] value of type Type
      */
     void SetValue( const Type& value )
     {
@@ -412,7 +412,7 @@ public:
  * @brief Extract a pointer to the held type of an Any object from a pointer to that Any object (NULL if empty )
  *
  * @SINCE_1_0.0
- * @param any Pointer to an Any object
+ * @param[in] any Pointer to an Any object
  *
  * @return Pointer to the Type held
  */
@@ -426,7 +426,7 @@ inline Type* AnyCast( Any* any )
  * @brief Extract a const pointer to the held type of an Any object from a pointer to that Any object (NULL if empty )
  *
  * @SINCE_1_0.0
- * @param any const Pointer to an Any object
+ * @param[in] any const Pointer to an Any object
  *
  * @return const Pointer to the Type held
  */
@@ -440,7 +440,7 @@ inline const Type* AnyCast( const Any* any )
  * @brief Extract a held value of type Type from an Any object from a reference to that Any object
  *
  * @SINCE_1_0.0
- * @param any reference to an Any object
+ * @param[in] any reference to an Any object
  *
  * @return Type value of type Type
  */
@@ -454,7 +454,7 @@ inline Type AnyCast( Any& any )
  * @brief Extract a held value of type Type from an Any object from a const reference to that Any object
  *
  * @SINCE_1_0.0
- * @param any reference to an Any object
+ * @param[in] any reference to an Any object
  *
  * @return Type value of type Type
  */
@@ -468,7 +468,7 @@ inline Type AnyCast( const Any& any )
  * @brief Extract a reference to the held value of type Type from an Any object from a reference to that Any object
  *
  * @SINCE_1_0.0
- * @param any reference to an Any object
+ * @param[in] any reference to an Any object
  *
  * @return A reference to the Type value of type Type
  */
@@ -482,7 +482,7 @@ inline Type& AnyCastReference( Any& any )
  * @brief Extract a const reference to the held value of type Type from an Any object from a const reference to that Any object
  *
  * @SINCE_1_0.0
- * @param any reference to an Any object
+ * @param[in] any reference to an Any object
  *
  * @return A const reference to the Type value of type Type
  */

diff --git a/dali/public-api/object/base-handle.h b/dali/public-api/object/base-handle.h
index 5e92153..8acba6d 100644 (file)
--- a/dali/public-api/object/base-handle.h
+++ b/dali/public-api/object/base-handle.h
@@ -272,7 +272,7 @@ private:
  * @brief Template wrapper to downcast a base object handle to derived class handle.
  *
  * @SINCE_1_0.0
- * @param handle to a base object
+ * @param[in] handle to a base object
  * @return handle pointer to either a valid deriving handle or an uninitialized handle
  * @pre The BaseHandle has been initialized.
  */

diff --git a/dali/public-api/object/property-map.h b/dali/public-api/object/property-map.h
index 43029b1..cd4daf1 100644 (file)
--- a/dali/public-api/object/property-map.h
+++ b/dali/public-api/object/property-map.h
@@ -86,8 +86,8 @@ public:
    *
    * Does not check for duplicates
    * @SINCE_1_0.0
-   * @param key to insert
-   * @param value to insert
+   * @param[in] key to insert
+   * @param[in] value to insert
    */
   void Insert( const char* key, const Value& value );
 
@@ -96,8 +96,8 @@ public:
    *
    * Does not check for duplicates
    * @SINCE_1_0.0
-   * @param key to insert
-   * @param value to insert
+   * @param[in] key to insert
+   * @param[in] value to insert
    */
   void Insert( const std::string& key, const Value& value );
 
@@ -106,8 +106,8 @@ public:
    *
    * Does not check for duplicates
    * @SINCE_1_1.39
-   * @param key to insert
-   * @param value to insert
+   * @param[in] key to insert
+   * @param[in] value to insert
    */
   void Insert( Property::Index key, const Value& value );