Diff: PMRC16ch.h

Revision:

24:4714402606f0

Parent:

23:cea3ec410735

Child:

25:953a60ea0e64

--- a/PMRC16ch.h	Wed Nov 07 16:38:00 2018 +0000
+++ b/PMRC16ch.h	Wed Nov 07 17:03:34 2018 +0000
@@ -1,33 +1,35 @@
 #ifndef PMRC_16CHANNEL_H
 #define PMRC_16CHANNEL_H
 /**
- *  PMRC16ch.h
- *  ----------------------------------------
- *  -  A Program with which to control
+ *  @file   PMRC16ch.h
+ *  @brief  PMRC16 class header file
+ *  
+ *  @par    About PMRC16 class
+ *  -   A Program with which to control
  *  Photo MOS Relay Circuit
  *  for 16 channels Electric Stimulation.
- *  -  Photo Couplers are controlled by
+ *  -   Photo Couplers are controlled by
  *  Shift Resisters. So this lib serves 
  *  shift resister's utility.
- *  ----------------------------------------
  *
- *  32 Photo MOS Relay IN
- *  16 channel OUT
- *   +--i      o----+----i      o--+
- *   |  [PMR01-1]   |    [PMR01-2] |
- *   |         (ch1(B)out)         |
- *   |                             |
- *   +--i      o----+----i      o--+
- *   |  [PMR02-1]   |    [PMR02-2] |
- *   |         (ch2(R)out)         |
- *   |                             |
- *   .              .              .
- *   .              .              .
- *   .              .              .
- *  Vpp                           GND
- *  ----------------------------------------
- *  Shit-Resister
- *  nOE is connected to GND
+ *  @par    Image of Photo MOS Relay Array
+ *  -   32 Photo MOS Relay IN               \n
+ *  -   16 channel OUT                      \n
+ *   +--i      o----+----i      o--+    \n
+ *   |  [PMR01-1]   |    [PMR01-2] |    \n
+ *   |         (ch1(B)out)         |    \n
+ *   |                             |    \n
+ *   +--i      o----+----i      o--+    \n
+ *   |  [PMR02-1]   |    [PMR02-2] |    \n
+ *   |         (ch2(R)out)         |    \n
+ *   |                             |    \n
+ *   .              .              .    \n
+ *   .              .              .    \n
+ *   .              .              .    \n
+ *  Vpp                           GND   \n
+ *
+ *  @par Info. Shit-Resister circuit board
+ *  -   nOE is connected to GND
  *  in
  *  ->[PMR01-1]->[PMR01-2]->[PMR02-1]->[PMR02-2]
  *  ->[PMR03-1]->[PMR03-2]->[PMR04-1]->[PMR04-2]
@@ -38,12 +40,12 @@
  *  ->[PMR13-1]->[PMR13-2]->[PMR14-1]->[PMR14-2]
  *  ->[PMR15-1]->[PMR15-2]->[PMR16-1]->[PMR16-2]
  *  ->out
- *  ----------------------------------------
- *  Log
- *  ver.1   2016/dec/11-
- *  ch.16 VER.
- *  ver.16.1    2018/jun/01-
- *  ver.16.2    2018/jun/28-
+ *
+ *  @par Log
+ *  -   ver.1   2016/dec/11-
+ *  -   ch.16 VER.
+ *  -   ver.16.1    2018/jun/01-
+ *  -   ver.16.2    2018/jun/28-
  *      major change
  */
 #include "mbed.h"