aboutsummaryrefslogtreecommitdiff
path: root/src/mnemonics/singleton.h
diff options
context:
space:
mode:
authorOran Juice <oranjuices@hotmail.com>2014-10-02 21:35:27 +0530
committerOran Juice <oranjuices@hotmail.com>2014-10-02 21:45:31 +0530
commitd683c8c724b59b2e8d01dcb45698c44b08186813 (patch)
treef226453543492862a2c9cd15b18c0a5545f2397e /src/mnemonics/singleton.h
parentCut short word lists to 1626 words, added attribution to Electrum, some bug f... (diff)
downloadmonero-d683c8c724b59b2e8d01dcb45698c44b08186813.tar.xz
Use reference types on LHS when using language methods
Diffstat (limited to '')
-rw-r--r--src/mnemonics/singleton.h18
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
{