update documentation

Author: 7bitcoder

Docs/advanced-guides.rst

@@ -6,10 +6,6 @@ Advanced Guides
    :titlesonly:
 
    advanced-guides/using-factories
+   advanced-guides/using-aliases
    advanced-guides/external-singleton
    advanced-guides/building-library
-   
-   
-   
-
-

Docs/advanced-guides/building-library.rst

@@ -20,8 +20,9 @@ Using this command several cache variables can be set:
 * <variable cache name>: [possible values] (default value) - Description
 * _7BIT_DI_LIBRARY_TYPE: ["Shared", "Static", "HeaderOnly"] ("Static") - Library build type
 * _7BIT_DI_BUILD_DOCS: ["ON", "OFF"] ("OFF") - Turn on to build documentation (requires Sphinx_, Breathe_ and Doxygen_ to be installed)
-* _7BIT_DI_BUILD_TESTS: ["ON", "OFF"] ("OFF") - Turn on to build tests (requires Gtest_ to be installed, see `Build Library With Conan`_)
+* _7BIT_DI_BUILD_TESTS: ["ON", "OFF"] ("OFF") - Turn on to build tests
 * _7BIT_DI_BUILD_EXAMPLES: ["ON", "OFF"] ("OFF") - Turn on to build examples
+* _7BIT_DI_BUILD_BENCHMARKS: ["ON", "OFF"] ("OFF") - Turn on to build benchmarks
 * _7BIT_DI_BUILD_SINGLE_HEADER: ["ON", "OFF"] ("OFF") - Turn on to build single header SevenBitDI.hpp (requires Quom_ to be installed)
 * _7BIT_DI_INSTALL: ["ON", "OFF"] ("OFF") - Turn on to install the library
 
@@ -39,45 +40,10 @@ Build the library using the command:
     cmake --build .
 
 
-Build Library With Conan
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Gtest_ library is added to project using Conan_ package manager (`Conan Installation`_), 
-If Conan was freshly installed run detect command:
-
-.. code-block:: sh
-
-    conan profile detect
-
-To install Conan packages run this command in the library root folder:
-
-.. code-block:: sh
-
-    conan install . --output-folder=build --build=missing
-
-Navigate to the build directory:
-
-.. code-block:: sh
-
-    cd build
-
-Configure the CMake project, and add also toolchain file as a CMAKE_TOOLCHAIN_FILE cache variable:
-
-.. code-block:: sh
-
-    cmake .. -DCMAKE_TOOLCHAIN_FILE:PATH="./conan_toolchain.cmake" -DCMAKE_BUILD_TYPE=Release -D_7BIT_DI_BUILD_TESTS=ON
-
-Build the library using the command:
-
-.. code-block:: sh
-
-    cmake --build .
-
-
 Install Library
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-To install the library set additional cache variables _7BIT_DI_BUILD_TESTS=ON and specify installation dir with CMAKE_INSTALL_PREFIX, then run the command
+To install the library set additional cache variables _7BIT_DI_INSTALL=ON and specify installation dir with CMAKE_INSTALL_PREFIX, then run the command
 
 .. code-block:: sh
 
@@ -91,4 +57,4 @@ To install the library set additional cache variables _7BIT_DI_BUILD_TESTS=ON an
 .. _Gtest: https://google.github.io/googletest/
 .. _Conan: https://conan.io/
 .. _Quom: https://pypi.org/project/quom/
-.. _`Conan Installation`: https://conan.io/downloads.html
+.. _`Conan Installation`: https://conan.io/downloads.html

Docs/advanced-guides/using-aliases.rst

@@ -0,0 +1,15 @@
+Using Aliases
+========================================
+
+With the use of aliases, one service can be injected through its multiple base classes, also aliases can be chained.
+If multiple aliases are registered with the same base class only last will be used.
+
+
+.. literalinclude:: ../../Examples/Guides/ServiceAliases.cpp
+   :caption: Examples/Guides/ServiceAliases
+   :language: C++
+
+.. code-block:: console
+   :caption: Output
+
+   actionA from top service, actionB from top service executed.

Docs/advanced-guides/using-factories.rst

@@ -2,9 +2,10 @@ Using Factories
 ========================================
 
 Factory functor can be provided to manually create a service.
-Functor should return unique_ptr or T if object is movable/copyable and should optionally take other services as arguments.
+Functor should return unique_ptr or raw object if the type is movable/copyable and should optionally take other services as arguments.
+
 Functor scheme (Services...) -> std::unique_ptr< T> | T
-Where Services are pointers, in place objects (if object is movable or copyable), unique pointers, references, vectors with pointers or unique pointers
+Where Services are pointers, in-place objects (if an object is movable or copyable), unique pointers, references, vectors with pointers or unique pointers
 
 .. literalinclude:: ../../Examples/Guides/FactoryFunctions.cpp
    :caption: Examples/Guides/FactoryFunctions

Docs/basic-guides/injecting-multiple-services.rst

@@ -5,7 +5,7 @@ Multiple services can inherit one interface and can be injected using a vector.
 
 .. Note::
    Service objects are ordered in vectors using registration order.
-   The last registered service of base type is used when resolving one service
+   The last registered service with the same base type is used when resolving one service
 
    Injection rules are simple:
 

Docs/basic-guides/injecting-services.rst

@@ -8,7 +8,7 @@ This example shows the main purpose of this library, injecting services into ser
 
    * Service should have one constructor
    * Singleton/scoped service should be injected using pointers or references
-   * Transient services should be injected using std::unique_ptr 
+   * Transient services should be injected using std::unique_ptr or directly by type if an object is movable or copyable
 
 .. literalinclude:: ../../Examples/Guides/InjectingServices.cpp
    :caption: Examples/Guides/InjectingServices

Docs/basic-guides/injection-rules.rst

@@ -14,15 +14,11 @@ Injecting Services
 ---------------------
 * Singleton/scoped services can be injected using one of:
     * References: (T&)
-    * Const references: (const T&)
     * Pointers: (T*)
-    * Const pointer: (T* const)
-    * Pointer to const object: (const T*)
-    * Const pointer to const object: (const T* const)
 * Transient services can be injected using one of:
     * std::unique_ptr: (unique_ptr<T>)
-    * In place object if type is movable or copyable: T
-* Multiple services implementing specified interface can be injected using std::vector:
+    * In-place object if type is movable or copyable: T
+* Multiple services implementing the same interface can be injected using std::vector:
     * Transient (std::vector<std::unique_ptr<T>>)
     * Singleton/scoped (std::vector<T*>)
 

Docs/basic-guides/services-lifetime.rst

@@ -9,14 +9,17 @@ Service providers can create scoped service providers:
    
    ServiceProvider scoped = provider.createScope()
 
+.. warning::
+   Root/main service provider cannot be destroyed before its children scoped providers this can lead to undefined behavior
+
 Service can be registered as a singleton, scoped, or transient.
 
 * Singleton: service provider will create only one instance of this service (accessible via the getService method)
 * Scoped: instance provider will create only one instance of this instance for each scope (accessible via the getService method)
-* Transient: services are always unique, a new service is provided every time it is requested, and the service provider returns, in this case, std::unique_ptr (accessible via createService method)
+* Transient: services are always unique, a new service is provided every time it is requested (accessible via createService or createInstanceInPlace method)
 
 .. warning::
-   Only transient services can be created using createInstance method otherwise the method will throw an exception
+   Only transient services can be created using createInstance/createInstanceInPlace method otherwise the method will throw an exception
 
    Only singleton/scoped services can be accessed using the getService method otherwise the method will throw an exception 
 

Docs/getting-started.rst

@@ -48,15 +48,15 @@ Installation
     .. code-block:: Txt
 
         [requires]
-        7bitdi/2.0.0
+        7bitdi/2.1.0
     
     change the version to newer if available, then run the command:
 
     .. code-block:: sh
 
         conan install . --output-folder=build --build=missing
 
-    Follow in detail instructions available at `Conan Tutorial`_
+    Follow in detailed instructions available at `Conan Tutorial`_
 
 #. Header only
     Download source code from the most recent release, 

Docs/reference/di.rst

@@ -13,7 +13,9 @@ sb::di
    di/servicecollection
    di/servicedescriber
    di/servicedescriptor
+   di/serviceinstance
    di/servicelifetime
+   di/servicelifetimes
    di/serviceprovider
    di/serviceprovideroptions
    di/typeid