Skip to content

Commit

Permalink
Clarifying shared_object comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
Gabriel Hare authored and codemercenary committed Aug 5, 2014
1 parent 2014716 commit 737bab3
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions autowiring/shared_object.h
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ class shared_object {
///<remarks>
///To copy the atomic_object referenced by source use:
/// shared_object<object> target(*unlock_object<object>(source));
///</remakrs>
///This method does NOT copy the atomic_object referenced by source.
///</remarks>
shared_object(const shared_object<object, lock>& source):
m_share(source.m_share) {}

Expand All @@ -65,6 +66,7 @@ class shared_object {
///<remarks>
///This method is equivalent to:
/// target = *unlock_object<object>(source);
///This method does NOT redirect the atomic_object reference to the reference of source.
///</remarks>
shared_object<object, lock>& operator = (const shared_object<object, lock>& source) {
*m_share = *source.m_share;
Expand Down Expand Up @@ -92,7 +94,7 @@ class shared_object {
}

///<summary>
///Atomic copy of this location to argument location, only if this has location.
///Atomic copy of target to this object, only if initialized() == false.
///</summary>
///<return>True if the object was not assigned default values</return>
bool initialized(object& target) {
Expand Down

0 comments on commit 737bab3

Please sign in to comment.