Purge underscored header file barriers

[platform/core/uifw/dali-core.git] / dali / public-api / actors / custom-actor.h

diff --git a/dali/public-api/actors/custom-actor.h b/dali/public-api/actors/custom-actor.h
index 12976c1..5f31322 100644 (file)
--- a/dali/public-api/actors/custom-actor.h
+++ b/dali/public-api/actors/custom-actor.h
@@ -1,8 +1,8 @@
-#ifndef __DALI_CUSTOM_ACTOR_H__
-#define __DALI_CUSTOM_ACTOR_H__
+#ifndef DALI_CUSTOM_ACTOR_H
+#define DALI_CUSTOM_ACTOR_H
 
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 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.
@@ -24,6 +24,10 @@
 
 namespace Dali
 {
+/**
+ * @addtogroup dali_core_actors
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -34,93 +38,97 @@ class CustomActor;
  * @brief CustomActor is a base class for custom UI controls.
  *
  * The implementation of the control must be supplied; see CustomActorImpl for more details.
+ * @SINCE_1_0.0
  */
-class DALI_IMPORT_API CustomActor : public Actor
+class DALI_CORE_API CustomActor : public Actor
 {
 public:
 
   /**
-   * @brief Create an uninitialized CustomActor handle.
+   * @brief Creates 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 Downcasts a handle to CustomActor handle.
    *
-   * If handle points to a CustomActor the downcast produces valid
-   * handle. If not the returned handle is left uninitialized.
+   * If the handle points to a CustomActor, the downcast produces valid handle.
+   * If not, the returned handle is left uninitialized.
    *
-   * @param[in] handle to An object
-   * @return handle to a CustomActor or an uninitialized handle
+   * @SINCE_1_0.0
+   * @param[in] handle Handle to an object
+   * @return Handle to a CustomActor or an uninitialized handle
    */
   static CustomActor DownCast( BaseHandle handle );
 
   /**
-   * @brief Destructor
+   * @brief Destructor.
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
+   * @SINCE_1_0.0
    */
   ~CustomActor();
 
   /**
-   * @brief Retrieve the custom actor implementation.
+   * @brief Retrieves the custom actor implementation.
    *
-   * @return The implementation.
+   * @SINCE_1_0.0
+   * @return The implementation
    */
   CustomActorImpl& GetImplementation();
 
   /**
-   * @brief Retrieve the custom actor implementation.
+   * @brief Retrieves the custom actor implementation.
    *
-   * @return The implementation.
+   * @SINCE_1_0.0
+   * @return The implementation
    */
   const CustomActorImpl& GetImplementation() const;
 
   /**
-   * @brief Create an initialised CustomActor.
+   * @brief Creates an initialized CustomActor.
    *
-   * @param[in] implementation The implementation for this custom actor.
-   * @return A handle to a newly allocated Dali resource.
+   * @SINCE_1_0.0
+   * @param[in] implementation The implementation for this custom actor
+   * @return A handle to a newly allocated Dali resource
    */
   CustomActor(CustomActorImpl& implementation);
 
   /**
-   * @brief Copy constructor
+   * @brief Copy constructor.
    *
-   * @param [in] copy The actor to copy.
+   * @SINCE_1_0.0
+   * @param[in] copy The actor to copy
    */
   CustomActor(const CustomActor& copy);
 
   /**
-   * @brief Assignment operator
+   * @brief Assignment operator.
    *
-   * @param [in] rhs The actor to copy.
+   * @SINCE_1_0.0
+   * @param[in] rhs The actor to copy
+   * @return A reference to this
    */
   CustomActor& operator=(const CustomActor& rhs);
 
-  /**
-   * @brief This method is defined to allow assignment of the NULL value,
-   * and will throw an exception if passed any other value.
-   *
-   * Assigning to NULL is an alias for Reset().
-   * @param [in] rhs  A NULL pointer
-   * @return A reference to this handle
-   */
-  CustomActor& operator=(BaseHandle::NullType* rhs);
-
 public: // Not intended for application developers
 
   /**
    * @brief This constructor is used internally to create additional CustomActor handles.
    *
-   * @param [in] actor A pointer to a newly allocated Dali resource
+   * @SINCE_1_0.0
+   * @param[in] actor A pointer to a newly allocated Dali resource
    */
   CustomActor(Internal::CustomActor* actor);
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
-#endif // __DALI_CUSTOM_ACTOR_H__
+#endif // DALI_CUSTOM_ACTOR_H