From cd1efd66a5fdb68d7d770d39ad45767111c315d1 Mon Sep 17 00:00:00 2001
From: sangelovic <angelovic.s@gmail.com>
Date: Fri, 25 Jan 2019 19:59:01 +0100
Subject: [PATCH] Add essential information to doxy comments of ProxyInterfaces
 constructors

---
 include/sdbus-c++/Interfaces.h | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/include/sdbus-c++/Interfaces.h b/include/sdbus-c++/Interfaces.h
index 45b33bd..2d0e6ac 100644
--- a/include/sdbus-c++/Interfaces.h
+++ b/include/sdbus-c++/Interfaces.h
@@ -100,6 +100,15 @@ namespace sdbus {
         , public _Interfaces...
     {
     public:
+        /*!
+        * @brief Creates fully working object proxy instance
+        *
+        * @param[in] destination Bus name that provides a D-Bus object
+        * @param[in] objectPath Path of the D-Bus object
+        *
+        * This constructor overload creates a proxy that manages its own D-Bus connection(s).
+        * For more information on its behavior, consult @ref createObjectProxy(std::string, std::string)
+        */
         ProxyInterfaces(std::string destination, std::string objectPath)
             : ObjectHolder<IObjectProxy>(createObjectProxy(std::move(destination), std::move(objectPath)))
             , _Interfaces(getObject())...
@@ -107,6 +116,16 @@ namespace sdbus {
             getObject().finishRegistration();
         }
 
+        /*!
+        * @brief Creates fully working object proxy instance
+        *
+        * @param[in] connection D-Bus connection to be used by the proxy object
+        * @param[in] destination Bus name that provides a D-Bus object
+        * @param[in] objectPath Path of the D-Bus object
+        *
+        * The proxy created this way just references a D-Bus connection owned and managed by the user.
+        * For more information on its behavior, consult @ref createObjectProxy(IConnection&,std::string, std::string)
+        */
         ProxyInterfaces(IConnection& connection, std::string destination, std::string objectPath)
             : ObjectHolder<IObjectProxy>(createObjectProxy(connection, std::move(destination), std::move(objectPath)))
             , _Interfaces(getObject())...
@@ -114,6 +133,16 @@ namespace sdbus {
             getObject().finishRegistration();
         }
 
+        /*!
+        * @brief Creates fully working object proxy instance
+        *
+        * @param[in] connection D-Bus connection to be used by the proxy object
+        * @param[in] destination Bus name that provides a D-Bus object
+        * @param[in] objectPath Path of the D-Bus object
+        *
+        * The proxy created this way becomes an owner of the connection.
+        * For more information on its behavior, consult @ref createObjectProxy(std::unique_ptr<sdbus::IConnection>&&,std::string, std::string)
+        */
         ProxyInterfaces(std::unique_ptr<sdbus::IConnection>&& connection, std::string destination, std::string objectPath)
             : ObjectHolder<IObjectProxy>(createObjectProxy(std::move(connection), std::move(destination), std::move(objectPath)))
             , _Interfaces(getObject())...