commit 2c28dbfabb442e5029179b1874e7dd677197ff24
author William A. Kennington III <wak@google.com> Mon Aug 27 10:30:54 2018 -0700
committer William A. Kennington III <wak@google.com> Mon Aug 27 11:46:32 2018 -0700
tree e9fc51b4e14c8aa9797124c2d0e18745f7972956
parent 5ddac180e254c1e03f6c20022718e5ff9623c298

internal/sys: Document

src/gpioplus/internal/sys.hpp

diff --git a/src/gpioplus/internal/sys.hpp b/src/gpioplus/internal/sys.hpp
index 37733b6..618259a 100644
--- a/src/gpioplus/internal/sys.hpp
+++ b/src/gpioplus/internal/sys.hpp
@@ -7,6 +7,9 @@
 namespace internal
 {
 
+/** @class Sys
+ *  @brief Overridable direct syscall interface
+ */
 class Sys
 {
   public:
@@ -34,6 +37,10 @@
                                    struct gpioevent_request* request) const = 0;
 };
 
+/** @class SysImpl
+ *  @brief syscall concrete implementation
+ *  @details Passes through all calls to the normal linux syscalls
+ */
 class SysImpl : public Sys
 {
   public:
@@ -56,6 +63,7 @@
                            struct gpioevent_request* request) const override;
 };
 
+/** @brief Default instantiation of sys */
 extern SysImpl sys_impl;
 
 } // namespace internal