30.11.2013 - New PICollection namespace, Android support, my own PIVector implementation

piobject.cpp

@@ -22,6 +22,39 @@
 PIVector<PIObject * > PIObject::objects;
 
 
+/** \class PIObject
+ * \brief This is base class for any classes which use events -> handlers mechanism.
+ * \details
+ * \section PIObject_sec0 Events and Event handlers
+ * %PIObject provide notification mechanism similar Qt but implemented
+ * on language capabilities without any special preprocessors or compilers.
+ * Any class inherits PIObject should use macro \a PIOBJECT() immediate
+ * after declaration to proper compile.
+ * 
+ * Event is a some abstract event that can be raised at any time.
+ * Event is a function but declared with special macro \a EVENT().
+ * To raise event simply execute event function.
+ * 
+ * Event handler is a function but declared with special macro
+ * \a EVENT_HANDLER(). You can use event handlers as ordinary functions.
+ * 
+ * Main goal of this mechanism is perform abstract connections between
+ * various objects. This functionality provide macro \a CONNECT() which
+ * connect some event of first object to some event handler or event of
+ * second object. Each event can be connected any times to any event handlers.
+ * 
+ * \image html events_handlers.png
+ * 
+ * Example: \snippet piobject.cpp main
+ * Result:
+\code{.cpp}
+handler B: 2 , 0.5
+handler A: event to handler
+handler A: event to event
+\endcode
+ */
+
+
 void PIObject::piConnect(const PIString & src, const PIString & sig, void * dest, void * ev_h) {
 	PIObject * o = findByName(src);
 	if (o == 0) {