King_DuckZ/Loki
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Added documentation comments for LockedStorage policy.

Browse source 
git-svn-id: svn://svn.code.sf.net/p/loki-lib/code/trunk@790 7ec92016-0320-0410-acc4-a06ded1c099a
This commit is contained in:
rich_sposato 2006-11-29 19:16:39 +00:00
parent 3b3153fd32
commit 6eabeea489
1 changed files with 21 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
include/loki/SmartPtr.h
View file

@ -220,9 +220,29 @@ namespace Loki
///
/// \ingroup SmartPointerStorageGroup
/// Implementation of the StoragePolicy used by SmartPtr.
/// Requires class T to have member functions Lock and Unlock.
///
/// Each call to operator-> locks the object for the duration of a call to a
/// member function of T.
///
/// \par How It Works
/// LockedStorage has a helper class called Locker, which acts as a smart
/// pointer with limited abilities. LockedStorage::operator-> returns an
/// unnamed temporary of type Locker<T> that exists for the duration of the
/// call to a member function of T. The unnamed temporary locks the object
/// when it is constructed by operator-> and unlocks the object when it is
/// destructed.
///
/// \note This storage policy requires class T to have member functions Lock
/// and Unlock. If your class does not have Lock or Unlock functions, you may
/// either make a child class which does, or make a policy class similar to
/// LockedStorage which calls other functions to lock the object.
////////////////////////////////////////////////////////////////////////////////
template <class T>
class LockedStorage
{
public:
template <class T>
class Locker
{
@ -255,11 +275,6 @@ namespace Loki
T * pointee_;
};
template <class T>
class LockedStorage
{
public:
typedef T* StoredType; /// the type of the pointee_ object
typedef T* InitPointerType; /// type used to declare OwnershipPolicy type.
typedef Locker< T > PointerType; /// type returned by operator->