src/core/singleton.h
changeset 3190 51fe9001a679
parent 2834 1aab57845b07
     1.1 --- a/src/core/singleton.h	Mon Mar 31 14:56:41 2008 -0700
     1.2 +++ b/src/core/singleton.h	Mon Jun 02 10:30:24 2008 -0700
     1.3 @@ -22,6 +22,17 @@
     1.4  
     1.5  namespace ns3 {
     1.6  
     1.7 +/**
     1.8 + * \brief a template singleton
     1.9 + *
    1.10 + * This template class can be used to implement the singleton pattern.
    1.11 + * The underlying object will be destroyed automatically when the process
    1.12 + * exits. Note that, if you call Singleton::Get again after the object has
    1.13 + * been destroyed, the object will be re-created which will result in a
    1.14 + * memory leak as reported by most memory leak checkers. It is up to the
    1.15 + * user to ensure that Singleton::Get is never called from a static variable
    1.16 + * finalizer.
    1.17 + */
    1.18  template <typename T>
    1.19  class Singleton
    1.20  {