Changeset 132 for trunk/nv/singleton.hh


Ignore:
Timestamp:
06/25/13 18:43:24 (12 years ago)
Author:
shark
Message:
  • Added missing spaces in all of my documentation comments (whoops!)
  • nv::to_string( string ) and nv::from_string( string, string ) were missing template <>
File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/nv/singleton.hh

    r110 r132  
    1919{
    2020        /**
    21          *singleton
    22          *@brief Represents an accessible static object that will only have one instance.
     21         * singleton
     22         * @brief Represents an accessible static object that will only have one instance.
    2323         */
    2424    template <class T>
     
    3131
    3232                /**
    33                  *Creates the single instance if one doesn't already exist.
     33                 * Creates the single instance if one doesn't already exist.
    3434                 */
    3535        singleton()
     
    4040
    4141                /**
    42                  *Destroys the instance.
     42                 * Destroys the instance.
    4343                 */
    4444        ~singleton()
     
    5050    public:
    5151                /**
    52                  *Checks to see if the instance exists.
     52                 * Checks to see if the instance exists.
    5353                 *
    54                  *@returns True if this singleton has an instance assigned, false otherwise.
     54                 * @returns True if this singleton has an instance assigned, false otherwise.
    5555                 */
    5656        static bool is_valid()
     
    6060
    6161                /**
    62                  *Returns the pointer to the instance.
     62                 * Returns the pointer to the instance.
    6363                 *
    64                  *@returns The pointer to the instance.
     64                 * @returns The pointer to the instance.
    6565                 */
    6666        static T *pointer()
     
    7070        }
    7171                /**
    72                  *Returns the object referenced by this singleton.
     72                 * Returns the object referenced by this singleton.
    7373                 */
    7474        static T &reference()
     
    8484
    8585        /**
    86          *auto_singleton
    87          *@brief Represents a singleton that automatically creates an instance if one doesn't already exist.
     86         * auto_singleton
     87         * @brief Represents a singleton that automatically creates an instance if one doesn't already exist.
    8888         */
    8989    template <class T>
     
    9292    public:
    9393                /**
    94                  *Returns the pointer to the instance.  Makes an instance if one doesn't already exist.
     94                 * Returns the pointer to the instance.  Makes an instance if one doesn't already exist.
    9595                 */
    9696        static T *pointer()
     
    104104
    105105                /**
    106                  *Returns the object referenced by this singleton.  Makes an instance if one doesn't already exist.
     106                 * Returns the object referenced by this singleton.  Makes an instance if one doesn't already exist.
    107107                 */
    108108        static T &reference()
Note: See TracChangeset for help on using the changeset viewer.