Documentation added

[mdictionary] / trunk / src / base / backbone / backbone.h

diff --git a/trunk/src/base/backbone/backbone.h b/trunk/src/base/backbone/backbone.h
index fdcce17..8a38f26 100644 (file)
--- a/trunk/src/base/backbone/backbone.h
+++ b/trunk/src/base/backbone/backbone.h
@@ -38,7 +38,16 @@
 #include "../../includes/translation.h"
 
 
-//! Inner part of dictionary - glues together GUI and plugins
+/*! Inner part of dictionary - glues together GUI and plugins
+
+  Backbone is responsible for managing plugins and dictionaries, starting
+  new searches and threads, merging search results from multiple dictionaries.
+
+  Each plugin may live in multiple instances - each with its own dictionary,
+  backbone must provide way to create them at start (with specific Settings) and
+  distinguich each ditionary.
+
+*/
 class Backbone : public QObject
 {
     Q_OBJECT
@@ -70,32 +79,42 @@ public Q_SLOTS:
     //! stops all current searches
     void stopSearching();
 
-    //! search for a word translation
+    /*! search for a word translation
+       \param word word to be translated
+      */
     void search(QString word);
 
-    //! sets active dictionaries
+    /*! sets active dictionaries (searches are performed only in active dicts
+       \param List of dictionaris to be activated
+      */
     void selectedDictionaries(QList<CommonDictInterface* >);
 
-    //! adds new dictionary
+    /*! adds new dictionary and activate it
+      \param dict dictionary to be added
+      */
     void addDictionary(CommonDictInterface* dict);
 
 
-    //! stops all current activity and kill plugins - be ready to exit
+    //! stops all current activity - emiting signal \see closeOk
     void quit();
 
 
-    //! Fired when dictionary call finalTranslation(..) with translation ready
+    /*! Fired with given interval during searches -
+        checking if translation is ready
+      */
     void translation();
 
-    //! Removes given dictionary
+    /*! Removes given dictionary
+        \param dict dictionary to be deleted
+      */
     void removeDictionary(CommonDictInterface* dict);
 
     // TODO addToBookmark(Translation*);
     // TODO removeFromBookmark(Translation*);
 
 Q_SIGNALS:
-    //! emmited when backbone is ready to close - after getting stop signal it
-    //!     should kill all threads and so on
+    /*! emmited when backbone is ready to close - after getting stop signal it
+        should kill all threads and so on */
     void closeOk();
 
     //! emitted when there are search result ready to fetch