Add more documentation.

[loba.git] / named_object_list.h

diff --git a/named_object_list.h b/named_object_list.h
index 2c91263f982325d049c1f32d19f26de2864c4156..929a0dbee112ca1d0796de11534980c9f70b4044 100644 (file)
--- a/named_object_list.h
+++ b/named_object_list.h
@@ -4,6 +4,17 @@
 #include <map>
 #include <string>
 
+// Define an associative container that maps a name with a class and a
+// description.  All classes must be derived from a same base class.
+//
+// We can then use the name to create an object of the associated
+// class, and to retrieve a pointer to this object.
+//
+// Furthermore, it is possible to iterate over the elements to get
+// their name and their description.
+
+// I am too lazy to comment the code, which should be obvious...
+
 //===== arity 0 =====
 
 template <typename Base>
@@ -143,6 +154,7 @@ public:
 
 //===================
 
+// "NOL" like in Named_Object_List....
 #define NOL_INSERT(name, descr, class) insert(name, new creator<class>(descr))
 
 #endif // !NAMED_OBJECT_LIST_H