Add internal tag to VectorAlgorithms

[platform/core/uifw/dali-core.git] / dali / public-api / common / intrusive-ptr.h

diff --git a/dali/public-api/common/intrusive-ptr.h b/dali/public-api/common/intrusive-ptr.h
index 9a775aa..02e5bad 100644 (file)
--- a/dali/public-api/common/intrusive-ptr.h
+++ b/dali/public-api/common/intrusive-ptr.h
@@ -1,8 +1,8 @@
-#ifndef __DALI_INTRUSIVE_PTR_H__
-#define __DALI_INTRUSIVE_PTR_H__
+#ifndef DALI_INTRUSIVE_PTR_H
+#define DALI_INTRUSIVE_PTR_H
 
 /*
- * Copyright (c) 2015 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.
@@ -29,7 +29,7 @@ namespace Dali
  */
 
 /**
- * @brief Templated intrusive pointer class
+ * @brief Templated intrusive pointer class.
  *
  * Uses the Dali:RefObject type with actual reference counting.
  * The object is responsible for destroying itself.
@@ -51,7 +51,7 @@ public:
    * @brief Constructor to attach existing object.
    *
    * @SINCE_1_0.0
-   * @param[in] p Pointer to object,
+   * @param[in] p Pointer to object
    */
   IntrusivePtr( T* p ) : mPtr( p )
   {
@@ -80,6 +80,7 @@ public:
   /**
    * @brief Copy constructor.
    * @SINCE_1_0.0
+   * @param[in] rhs Const reference to an IntrusivePtr
    */
   IntrusivePtr( IntrusivePtr const& rhs ) : mPtr( rhs.mPtr )
   {
@@ -92,7 +93,7 @@ public:
   /**
    * @brief Destructor.
    *
-   * Object will self-destruct if reference count is zero
+   * Object will self-destruct if reference count is zero.
    * @SINCE_1_0.0
    */
   ~IntrusivePtr()
@@ -104,7 +105,7 @@ public:
   }
 
   /**
-   * @brief Get pointer to reference counted object.
+   * @brief Gets pointer to reference counted object.
    *
    * @SINCE_1_0.0
    * @return Pointer to reference counted object
@@ -203,10 +204,11 @@ public:
   }
 
   /**
-   * @brief Detach pointer from intrusive ptr counting.
+   * @brief Detaches pointer from intrusive ptr counting.
    *
    * Use with care.
    * @SINCE_1_0.0
+   * @return Pointer to reference counted object
    */
   T* Detach()
   {
@@ -224,7 +226,7 @@ private:
   void ThisIsSaferThanReturningVoidStar() const {}
 
   /**
-   * @brief Internal swap function
+   * @brief Internal swap function.
    * @SINCE_1_0.0
    */
   void Swap( IntrusivePtr& rhs )
@@ -266,7 +268,7 @@ inline bool operator!=( IntrusivePtr<T>const& lhs, IntrusivePtr<U>const &rhs)
 }
 
 /**
- * @brief Comparison overrides of objects wrapped by intrusive pointers
+ * @brief Comparison overrides of objects wrapped by intrusive pointers.
  *
  * @SINCE_1_0.0
  * @param[in] lhs Intrusive pointer to compare with
@@ -294,7 +296,7 @@ inline bool operator!=( IntrusivePtr<T>const& lhs, U* rhs )
 }
 
 /**
- * @brief Comparison overrides of objects wrapped by intrusive pointers
+ * @brief Comparison overrides of objects wrapped by intrusive pointers.
  *
  * @SINCE_1_0.0
  * @param[in] lhs Object to compare with
@@ -308,7 +310,7 @@ inline bool operator==( T* lhs, IntrusivePtr<U>const& rhs )
 }
 
 /**
- * @brief Comparison overrides of objects wrapped by intrusive pointers
+ * @brief Comparison overrides of objects wrapped by intrusive pointers.
  *
  * @SINCE_1_0.0
  * @param[in] lhs Object to compare with
@@ -326,4 +328,4 @@ inline bool operator!=( T* lhs, IntrusivePtr<U>const& rhs )
  */
 } // namespace Dali
 
-#endif /* __DALI_INTRUSIVE_PTR_H__ */
+#endif // DALI_INTRUSIVE_PTR_H