summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTobias Markmann <tm@ayena.de>2014-12-17 14:55:58 (GMT)
committerTobias Markmann <tm@ayena.de>2015-01-19 12:15:17 (GMT)
commit22ad0360bb273c62af4e5a2106f4e87c1b4fa3ac (patch)
treef1f846bda968c631a91cfda4c94e05e419ffa2d1 /Swiften
parent8d8e7ec1f200a53ac835435aeaabac4d6a40f3a6 (diff)
downloadswift-22ad0360bb273c62af4e5a2106f4e87c1b4fa3ac.zip
swift-22ad0360bb273c62af4e5a2106f4e87c1b4fa3ac.tar.bz2
Declare SimpleIDGenerator as an implementation of the IDGenerator abstract class.
In addition this commit also adds brief documentation for the SimpleIDGenerator. Test-Information: Builds and runs fine on OS X 10.9.5. Change-Id: I87360933d50c7bb56b19859c9890d9000d3c147b
Diffstat (limited to 'Swiften')
-rw-r--r--Swiften/Base/SimpleIDGenerator.h11
1 files changed, 9 insertions, 2 deletions
diff --git a/Swiften/Base/SimpleIDGenerator.h b/Swiften/Base/SimpleIDGenerator.h
index 1bd3d9a..e4fa3f5 100644
--- a/Swiften/Base/SimpleIDGenerator.h
+++ b/Swiften/Base/SimpleIDGenerator.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2010 Isode Limited.
+ * Copyright (c) 2010-2015 Isode Limited.
* All rights reserved.
* See the COPYING file for more information.
*/
@@ -9,9 +9,16 @@
#include <string>
#include <Swiften/Base/API.h>
+#include <Swiften/Base/IDGenerator.h>
namespace Swift {
- class SWIFTEN_API SimpleIDGenerator {
+
+ /**
+ * @brief The SimpleIDGenerator class implements a IDGenerator generating consecutive ID strings from
+ * the lower case latin alphabet.
+ */
+
+ class SWIFTEN_API SimpleIDGenerator : public IDGenerator {
public:
SimpleIDGenerator();