update outletController docs

magao-x · Dec 8, 2023 · 2ecd896 · 2ecd896
1 parent 2ac2b01
commit 2ecd896
Showing 1 changed file with 16 additions and 2 deletions.
diff --git a/libMagAOX/app/dev/outletController.hpp b/libMagAOX/app/dev/outletController.hpp
@@ -39,11 +39,25 @@ namespace dev
 /** Controls a set of outlets on a device, such as A/C power outlets or digital outputs.
   * The outlets are organized into channels, which could be made up of multiple outlets.
   *
-  * Requirements:
+  * derivedT must be a MagAOXApp, and additionally it must implement the functions
+  * \code
+    int turnOutletOn( int outletNum );
+
+    int turnOutletOff( int outletNum );
+
+    int updateOutletState( int outletNum );
+  * \endcode 
+  * and optionally
+  * \code
+    int updateOutletStates();
+    \endcode
+  *
+  * Other requirements:
   * - call `setNumberOfOutlets` in the derived class constructor
   * 
   * 
-  * \tparam derivedT specifies a MagAOXApp parent base class which is accessed with a `static_cast` (downcast)to perform various methods.
+  * \tparam derivedT specifies a MagAOXApp parent base class which is accessed with a `static_cast` (downcast)
+  *         to perform various methods.
   *
   * \ingroup appdev
   *