Recent changes to API documentation

API documentation modified by Jochen Baier

Jochen Baier — Mon, 20 May 2013 19:50:17 -0000

--- v7
+++ v8
@@ -29,7 +29,7 @@
 //create a new one.
 template  bool QuteContainer::deleteSingleton()

-Method checks if all dependencies are fulfilled and no circular dependencies exits.
+//Method checks if all dependencies are fulfilled and no circular dependencies exits.
 bool QuteContainer::runChecks();

 //Returns the result code for each Method call. Success: QuteContainer::Success

API documentation modified by Jochen Baier

Jochen Baier — Mon, 20 May 2013 19:49:06 -0000

--- v6
+++ v7
@@ -1,4 +1,3 @@
-
 ~~~~~~~~~~
 :::C++
 //QuteContainer is the Inversion of Control container class. It used to register 
@@ -7,30 +6,31 @@

 //Method to register Interfaces which are mapped to a class.
+//'Type' must derive from 'Interface'
 //With 'isSingleton' you can control the lifetime of the resolved class.
 template 
-    void registerType(bool isSingleton=false)
+    void QuteContainer::registerType(bool isSingleton=false)

-//Method to register classes directly. Usefull if no Interface is available.
+//Method to register classes directly. Useful if no interface is available.
  template 
-    void registerType(bool isSingelton=false)
+    void QuteContainer::registerType(bool isSingelton=false)

-//Register an allredy created object. If the instance parent is 0 the lifetime 
-//is mananged by he QuteContainer.
-void registerInstance(QObject *instance);
+//Register an already created object. If the instance parent is 0 the lifetime 
+//is mananged by the QuteContainer.
+void QuteContainer::registerInstance(QObject *instance);

 //Method to resolve a registered interface or class
-template  T* resolve()
+template  T* QuteContainer::resolve()

 //Returns if a resolved singleton object is not deleted.
-template  bool isSingletonAlive()
+template  bool QuteContainer::isSingletonAlive()

 //Method will delete a singleton object if alive. QuteContaier::Resolve() will 
 //create a new one.
-template  bool deleteSingleton()
+template  bool QuteContainer::deleteSingleton()

-Method checks if all dependencies are fulfield and no circual dependencies exits.
-bool runChecks();
+Method checks if all dependencies are fulfilled and no circular dependencies exits.
+bool QuteContainer::runChecks();

 //Returns the result code for each Method call. Success: QuteContainer::Success
-QuteContainer::Result getLastResult() {return m_lastResult;}
+QuteContainer::Result QuteContainer::getLastResult() {return m_lastResult;}

API documentation modified by Jochen Baier

Jochen Baier — Mon, 20 May 2013 19:45:21 -0000

--- v5
+++ v6
@@ -1,59 +1,36 @@
-~~~~~~~~~~
-:::C++
-QuteContainer
-~~~~~~~~~~
-
-QuteContainer is the Inversion of Control container class. It used to register and resolve objects.

 ~~~~~~~~~~
 :::C++
+//QuteContainer is the Inversion of Control container class. It used to register 
+//and resolve objects.
+class QuteContainer
+
+
+//Method to register Interfaces which are mapped to a class.
+//With 'isSingleton' you can control the lifetime of the resolved class.
 template 
     void registerType(bool isSingleton=false)
-~~~~~~~~~
-Method to register Interfaces which are mapped to a class.
-With 'isSingleton' you can control the lifetime of the resolved class.

-~~~~~~~~~~
-:::C++
+//Method to register classes directly. Usefull if no Interface is available.
  template 
     void registerType(bool isSingelton=false)
-~~~~~~~~~~
-Method to register classes directly. Usefull if no Interface is available.

-~~~~~~~~~~
-:::C++
+//Register an allredy created object. If the instance parent is 0 the lifetime 
+//is mananged by he QuteContainer.
 void registerInstance(QObject *instance);
-~~~~~~~~~~
-Register an allredy created object. If the instance parent is 0 the lifetime is mananged by
-the QuteContainer.

-~~~~~~~~~~
-:::C++
+//Method to resolve a registered interface or class
 template  T* resolve()
-~~~~~~~~~~
-Method to resolve a registered interface or class. 

-~~~~~~~~~~
-:::C++
+//Returns if a resolved singleton object is not deleted.
 template  bool isSingletonAlive()
-~~~~~~~~~~
-Returns if a resolved singleton object is not deleted.

-~~~~~~~~~~
-:::C++
+//Method will delete a singleton object if alive. QuteContaier::Resolve() will 
+//create a new one.
 template  bool deleteSingleton()
-~~~~~~~~~~
-Method will delete a singleton object if alive. QuteContaier::Resolve() will create a new one.

-~~~~~~~~~~
-:::C++
+Method checks if all dependencies are fulfield and no circual dependencies exits.
 bool runChecks();
-~~~~~~~~~~
-Method checks if all dependencies are fulfield and no circual dependencies exits.

-~~~~~~~~~~
-:::C++
+//Returns the result code for each Method call. Success: QuteContainer::Success
 QuteContainer::Result getLastResult() {return m_lastResult;}
-~~~~~~~~~~
-Returns the result code for each Method call. Success: QuteContainer::Success
-

API documentation modified by Jochen Baier

Jochen Baier — Mon, 20 May 2013 19:38:47 -0000

--- v4
+++ v5
@@ -2,7 +2,9 @@
 :::C++
 QuteContainer
 ~~~~~~~~~~
+
 QuteContainer is the Inversion of Control container class. It used to register and resolve objects.
+
 ~~~~~~~~~~
 :::C++
 template 
@@ -10,40 +12,48 @@
 ~~~~~~~~~
 Method to register Interfaces which are mapped to a class.
 With 'isSingleton' you can control the lifetime of the resolved class.
+
 ~~~~~~~~~~
 :::C++
  template 
     void registerType(bool isSingelton=false)
 ~~~~~~~~~~
 Method to register classes directly. Usefull if no Interface is available.
+
 ~~~~~~~~~~
 :::C++
 void registerInstance(QObject *instance);
 ~~~~~~~~~~
-Register an alredy created object. If the instance parent is 0 the lifetime is mananged by
+Register an allredy created object. If the instance parent is 0 the lifetime is mananged by
 the QuteContainer.
+
 ~~~~~~~~~~
 :::C++
 template  T* resolve()
 ~~~~~~~~~~
 Method to resolve a registered interface or class. 
+
 ~~~~~~~~~~
 :::C++
 template  bool isSingletonAlive()
 ~~~~~~~~~~
 Returns if a resolved singleton object is not deleted.
+
 ~~~~~~~~~~
 :::C++
 template  bool deleteSingleton()
 ~~~~~~~~~~
 Method will delete a singleton object if alive. QuteContaier::Resolve() will create a new one.
+
 ~~~~~~~~~~
 :::C++
 bool runChecks();
 ~~~~~~~~~~
 Method checks if all dependencies are fulfield and no circual dependencies exits.
+
 ~~~~~~~~~~
 :::C++
 QuteContainer::Result getLastResult() {return m_lastResult;}
 ~~~~~~~~~~
 Returns the result code for each Method call. Success: QuteContainer::Success
+

API documentation modified by Jochen Baier

Jochen Baier — Mon, 20 May 2013 19:35:05 -0000

--- v3
+++ v4
@@ -3,8 +3,6 @@
 QuteContainer
 ~~~~~~~~~~
 QuteContainer is the Inversion of Control container class. It used to register and resolve objects.
-
-
 ~~~~~~~~~~
 :::C++
 template 
@@ -12,37 +10,40 @@
 ~~~~~~~~~
 Method to register Interfaces which are mapped to a class.
 With 'isSingleton' you can control the lifetime of the resolved class.
-
 ~~~~~~~~~~
 :::C++
  template 
     void registerType(bool isSingelton=false)
 ~~~~~~~~~~
 Method to register classes directly. Usefull if no Interface is available.
-
-
 ~~~~~~~~~~
 :::C++
 void registerInstance(QObject *instance);
 ~~~~~~~~~~
 Register an alredy created object. If the instance parent is 0 the lifetime is mananged by
 the QuteContainer.
-
 ~~~~~~~~~~
 :::C++
 template  T* resolve()
 ~~~~~~~~~~
 Method to resolve a registered interface or class. 
-
 ~~~~~~~~~~
 :::C++
 template  bool isSingletonAlive()
 ~~~~~~~~~~
 Returns if a resolved singleton object is not deleted.
-
-
 ~~~~~~~~~~
 :::C++
 template  bool deleteSingleton()
 ~~~~~~~~~~
 Method will delete a singleton object if alive. QuteContaier::Resolve() will create a new one.
+~~~~~~~~~~
+:::C++
+bool runChecks();
+~~~~~~~~~~
+Method checks if all dependencies are fulfield and no circual dependencies exits.
+~~~~~~~~~~
+:::C++
+QuteContainer::Result getLastResult() {return m_lastResult;}
+~~~~~~~~~~
+Returns the result code for each Method call. Success: QuteContainer::Success

API documentation modified by Jochen Baier

Jochen Baier — Mon, 20 May 2013 19:32:35 -0000

--- v2
+++ v3
@@ -10,8 +10,8 @@
 template 
     void registerType(bool isSingleton=false)
 ~~~~~~~~~
-Method to register Interfaces which are mapped to a class. With isSingleton
-you can control the lifetime of the resolved class.
+Method to register Interfaces which are mapped to a class.
+With 'isSingleton' you can control the lifetime of the resolved class.

 ~~~~~~~~~~
 :::C++
@@ -19,3 +19,30 @@
     void registerType(bool isSingelton=false)
 ~~~~~~~~~~
 Method to register classes directly. Usefull if no Interface is available.
+
+
+~~~~~~~~~~
+:::C++
+void registerInstance(QObject *instance);
+~~~~~~~~~~
+Register an alredy created object. If the instance parent is 0 the lifetime is mananged by
+the QuteContainer.
+
+~~~~~~~~~~
+:::C++
+template  T* resolve()
+~~~~~~~~~~
+Method to resolve a registered interface or class. 
+
+~~~~~~~~~~
+:::C++
+template  bool isSingletonAlive()
+~~~~~~~~~~
+Returns if a resolved singleton object is not deleted.
+
+
+~~~~~~~~~~
+:::C++
+template  bool deleteSingleton()
+~~~~~~~~~~
+Method will delete a singleton object if alive. QuteContaier::Resolve() will create a new one.

API documentation modified by Jochen Baier

Jochen Baier — Mon, 20 May 2013 19:27:22 -0000

--- v1
+++ v2
@@ -1,5 +1,7 @@
-###QuteContainer Class###
-
+~~~~~~~~~~
+:::C++
+QuteContainer
+~~~~~~~~~~
 QuteContainer is the Inversion of Control container class. It used to register and resolve objects.

@@ -10,3 +12,10 @@
 ~~~~~~~~~
 Method to register Interfaces which are mapped to a class. With isSingleton
 you can control the lifetime of the resolved class.
+
+~~~~~~~~~~
+:::C++
+ template 
+    void registerType(bool isSingelton=false)
+~~~~~~~~~~
+Method to register classes directly. Usefull if no Interface is available.

API documentation modified by Jochen Baier

Jochen Baier — Mon, 20 May 2013 19:25:43 -0000

QuteContainer Class

QuteContainer is the Inversion of Control container class. It used to register and resolve objects.

template <typename Interface, typename Type>
    void registerType(bool isSingleton=false)

Method to register Interfaces which are mapped to a class. With isSingleton
you can control the lifetime of the resolved class.