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

add documenation

Browse source 
git-svn-id: svn://svn.code.sf.net/p/loki-lib/code/trunk@592 7ec92016-0320-0410-acc4-a06ded1c099a
This commit is contained in:
syntheticpp 2006-03-08 16:39:27 +00:00
parent 80d84f878b
commit e9711d3cfe
1 changed files with 36 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

41
include/loki/Pimpl.h
View file

@ -12,6 +12,9 @@
#ifndef LOKI_PIMPL_H #ifndef LOKI_PIMPL_H
#define LOKI_PIMPL_H #define LOKI_PIMPL_H
// $Header$
/// \defgroup PimplGroup Pimpl
#ifndef LOKI_INHERITED_PIMPL_NAME #ifndef LOKI_INHERITED_PIMPL_NAME
#define LOKI_INHERITED_PIMPL_NAME d #define LOKI_INHERITED_PIMPL_NAME d
@ -25,7 +28,11 @@ namespace Loki
{ {
////////////////////////////////////////// //////////////////////////////////////////
// simple const propagating pointer /// \class ConstPropPtr
///
/// \ingroup PimplGroup
/// Simple const propagating smart pointer
/// Is the default smart pointer of Pimpl.
////////////////////////////////////////// //////////////////////////////////////////
template<class T> template<class T>
@ -46,9 +53,18 @@ namespace Loki
}; };
///////////////////// ////////////////////////////////////////////////////////////////////////////////
// Pimpl /// \class Pimpl
///////////////////// ///
/// \ingroup PimplGroup
///
/// Implements the Pimpl idiom. It's a wrapper for a smart pointer which
/// automatically creates and deletes the implementation object and adds
/// const propagation to the smart pointer.
///
/// \par Usage
/// see test/Pimpl
////////////////////////////////////////////////////////////////////////////////
template template
< <
@ -124,13 +140,25 @@ namespace Loki
////////////////////////////////////////// //////////////////////////////////////////
// template for the implementations /// \class ImplT
///
/// \ingroup PimplGroup
/// Convenience template for the
/// implementations which PimplT points to.
////////////////////////////////////////// //////////////////////////////////////////
template<class T> template<class T>
struct ImplT; struct ImplT;
//////////////////////////////////////////
/// \class PImplT
///
/// \ingroup PimplGroup
/// Convenience template which uses ImplT
/// as implementation structure
//////////////////////////////////////////
template<class T, template<class> class Ptr = ConstPropPtr> template<class T, template<class> class Ptr = ConstPropPtr>
struct PimplT struct PimplT
@ -168,6 +196,9 @@ namespace Loki
#endif #endif
// $Log$ // $Log$
// Revision 1.18 2006/03/08 16:39:27 syntheticpp
// add documenation
//
// Revision 1.17 2006/03/02 09:55:37 syntheticpp // Revision 1.17 2006/03/02 09:55:37 syntheticpp
// don't compile with incomplete types // don't compile with incomplete types
// //