Add function prologue for getManagedObjects
Tested: N/A
Change-Id: I5571f6ab5e43f534a1825ac2a5190b63e54e6f2d
Signed-off-by: Matt Spinler <spinler@us.ibm.com>
diff --git a/dbus.hpp b/dbus.hpp
index 38e62bd..d3c6152 100644
--- a/dbus.hpp
+++ b/dbus.hpp
@@ -22,6 +22,18 @@
using ObjectValueTree =
std::map<sdbusplus::message::object_path, DbusInterfaceMap>;
+/**
+ * Returns the managed objects for an object path and service
+ *
+ * Returns an empty map if there are any failures.
+ *
+ * @param[in] bus - the D-Bus object
+ * @param[in] service - the D-Bus service name
+ * @param[in] objPath - the D-Bus object path
+ *
+ * @return ObjectValueTree - A map of object paths to their
+ * interfaces and properties.
+ */
ObjectValueTree getManagedObjects(sdbusplus::bus::bus& bus,
const std::string& service,
const std::string& objPath);