{event,handle}: Clarify object lifetime requirements
It was unclear from the current docuemntation that Handles and Events do
not depend on the Chip or their input flags remaining alive during
the lifetime of the object. This makes that more clear.
Change-Id: I9831d7ffd095045a0a381b9863ce684bab22baae
Signed-off-by: William A. Kennington III <wak@google.com>
diff --git a/src/gpioplus/event.hpp b/src/gpioplus/event.hpp
index 02c3cc2..ce90f64 100644
--- a/src/gpioplus/event.hpp
+++ b/src/gpioplus/event.hpp
@@ -34,6 +34,9 @@
{
public:
/** @brief Creates a new gpio line event handler
+ * The underlying implementation of the event is independent of
+ * the provided chip object. It is safe to destroy any of the
+ * provided inputs while this event is alive.
*
* @param[in] chip - The gpio chip which provides the events
* @param[in] line_offset - The offset of the line generating events
diff --git a/src/gpioplus/handle.hpp b/src/gpioplus/handle.hpp
index 3a66518..1837c76 100644
--- a/src/gpioplus/handle.hpp
+++ b/src/gpioplus/handle.hpp
@@ -52,6 +52,9 @@
};
/** @brief Creates a new gpio handle
+ * The underlying implementation of the handle is independent of
+ * the provided chip object. It is safe to destroy any of the
+ * provided inputs while this handle is alive.
*
* @param[in] chip - The gpio chip which provides the handle
* @param[in] lines - A collection of lines the handle provides