feedc0de/boost_smart_ptr
1
0
Fork 0
forked from boostorg/smart_ptr
Code Pull Requests Activity

Add _add_ref and _release overload documentation

Browse Source
This commit is contained in:
Glen Fernandes
2017-06-15 11:33:06 -04:00
parent 61de342adc
commit 6db55f7dfd
1 changed files with 32 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
doc/smart_ptr/intrusive_ref_counter.adoc
View File

@@ -60,6 +60,14 @@ namespace boost {
protected: protected:
~intrusive_ref_counter() = default; ~intrusive_ref_counter() = default;
}; };
template<class Derived, class CounterPolicy>
void intrusive_ptr_add_ref(
const intrusive_ref_counter<Derived, CounterPolicy>* p) noexcept;
template<class Derived, class CounterPolicy>
void intrusive_ptr_release(
const intrusive_ref_counter<Derived, CounterPolicy>* p) noexcept;
} }
``` ```
@@ -99,7 +107,7 @@ intrusive_ref_counter& operator=(const intrusive_ref_counter& v) noexcept;
``` ```
:: ::
Effects::: Does nothing, reference counter is not modified. Effects::: Does nothing, reference counter is not modified.
y
### use_count ### use_count
``` ```
@@ -109,3 +117,26 @@ unsigned int use_count() const noexcept;
Returns::: The current value of the reference counter. Returns::: The current value of the reference counter.
NOTE: The returned value may not be actual in multi-threaded applications. NOTE: The returned value may not be actual in multi-threaded applications.
## Free Functions
### intrusive_ptr_add_ref
```
template<class Derived, class CounterPolicy>
void intrusive_ptr_add_ref(
const intrusive_ref_counter<Derived, CounterPolicy>* p) noexcept;
```
::
Effects::: Increments the reference counter.
### intrusive_ptr_release
```
template<class Derived, class CounterPolicy>
void intrusive_ptr_release(
const intrusive_ref_counter<Derived, CounterPolicy>* p) noexcept;
```
::
Effects::: Decrements the reference counter. If the reference counter reaches
0, calls `delete static_cast<const Derived*>(p)`.