exception: Document header

1 files changed, 9 insertions, 0 deletions

diff --git a/src/sdeventplus/exception.hpp b/src/sdeventplus/exception.hpp
index 5412d70..697ccb1 100644
--- a/src/sdeventplus/exception.hpp
+++ b/src/sdeventplus/exception.hpp
@@ -5,9 +5,18 @@
 namespace sdeventplus
 {
 
+/** @class SdEventError
+ *  @brief Holds information about underlying sd_event
+ *         issued errors
+ */
 class SdEventError final : public std::system_error
 {
   public:
+    /** @brief Creates a new SdEventError from error data
+     *
+     * @param[in] r      - The postive errno code
+     * @param[in] prefix - The prefix string to display in the what()
+     */
     SdEventError(int r, const char* prefix);
 };