Update Actors' public header comments
[platform/core/uifw/dali-core.git] / dali / public-api / actors / custom-actor.h
index fe82c02..e255ba2 100644 (file)
@@ -48,20 +48,20 @@ public:
    * @brief Create an uninitialized CustomActor handle.
    *
    * Only derived versions can be instantiated.
-   * Calling member functions with an uninitialized Dali::Object is not allowed.
+   * Calling member functions with an uninitialized CustomActor handle is not allowed.
    * @SINCE_1_0.0
    */
   CustomActor();
 
   /**
-   * @brief Downcast an Object handle to CustomActor.
+   * @brief Downcast a handle to CustomActor handle.
    *
    * If handle points to a CustomActor the downcast produces valid
    * handle. If not the returned handle is left uninitialized.
    *
    * @SINCE_1_0.0
-   * @param[in] handle to An object
-   * @return handle to a CustomActor or an uninitialized handle
+   * @param[in] handle Handle to an object
+   * @return Handle to a CustomActor or an uninitialized handle
    */
   static CustomActor DownCast( BaseHandle handle );
 
@@ -77,7 +77,7 @@ public:
    * @brief Retrieve the custom actor implementation.
    *
    * @SINCE_1_0.0
-   * @return The implementation.
+   * @return The implementation
    */
   CustomActorImpl& GetImplementation();
 
@@ -85,7 +85,7 @@ public:
    * @brief Retrieve the custom actor implementation.
    *
    * @SINCE_1_0.0
-   * @return The implementation.
+   * @return The implementation
    */
   const CustomActorImpl& GetImplementation() const;
 
@@ -93,8 +93,8 @@ public:
    * @brief Create an initialised CustomActor.
    *
    * @SINCE_1_0.0
-   * @param[in] implementation The implementation for this custom actor.
-   * @return A handle to a newly allocated Dali resource.
+   * @param[in] implementation The implementation for this custom actor
+   * @return A handle to a newly allocated Dali resource
    */
   CustomActor(CustomActorImpl& implementation);
 
@@ -102,7 +102,7 @@ public:
    * @brief Copy constructor
    *
    * @SINCE_1_0.0
-   * @param [in] copy The actor to copy.
+   * @param [in] copy The actor to copy
    */
   CustomActor(const CustomActor& copy);
 
@@ -110,7 +110,8 @@ public:
    * @brief Assignment operator
    *
    * @SINCE_1_0.0
-   * @param [in] rhs The actor to copy.
+   * @param [in] rhs The actor to copy
+   * @return A reference to this
    */
   CustomActor& operator=(const CustomActor& rhs);