diff options
Diffstat (limited to 'src/mnemonics/singleton.h')
| -rw-r--r-- | src/mnemonics/singleton.h | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/src/mnemonics/singleton.h b/src/mnemonics/singleton.h index 74cc290fc..5a86c2e7c 100644 --- a/src/mnemonics/singleton.h +++ b/src/mnemonics/singleton.h @@ -26,8 +26,26 @@ // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/*!
+ * \file singleton.h
+ *
+ * \brief A singleton helper class based on template.
+ */
+
+/*!
+ * \namespace Language
+ * \brief Mnemonic language related namespace.
+ */
namespace Language
{
+ /*!
+ * \class Singleton
+ *
+ * \brief Single helper class.
+ *
+ * Do Language::Singleton<YourClass>::instance() to create a singleton instance
+ * of `YourClass`.
+ */
template <class T>
class Singleton
{
|