Update Readme_USB-Relay-DLL.md
authorPavel A. <pavel-a@users.noreply.github.com>
Mon, 12 Jan 2015 01:10:33 +0000 (03:10 +0200)
committerPavel A. <pavel-a@users.noreply.github.com>
Mon, 12 Jan 2015 01:10:33 +0000 (03:10 +0200)
doc/Readme_USB-Relay-DLL.md

index 7ba98e383e21e4373ee41e5438488cbf7f839bdc..ce7888b162e4a5fb7859b456b9ce5c9e61aa0526 100644 (file)
@@ -28,50 +28,50 @@ The DLL may require VC++ redistributable runtime library.
 Using the API:
 --------------   
 
- * usb_relay_init()
+ * `usb_relay_init()`
  Call this before calling other functions
 
- * usb_relay_device_enumerate()
+ * `usb_relay_device_enumerate`
  Enumerates all Relay devices plugged into the PC.
  Returns list of usb_relay_device_info structures.
  Caller should free this list by passing it to usb_relay_device_free_enumerate().
  
- * usb_relay_device_open()
+ * `usb_relay_device_open`
  Opens one Relay board device by its usb_relay_device_info structure,
  obtained from usb_relay_device_enumerate().
 
- * usb_relay_device_open_with_serial_number
+ * `usb_relay_device_open_with_serial_number`
  Opens one Relay board device by its serial number string.
  These strings can be obtained from usb_relay_device_enumerate().
   
- * usb_relay_device_open_one_relay_channel
+ * `usb_relay_device_open_one_relay_channel`
   Turns ON one channel of a Relay board.
   Parameters: 
      - device handle, obtained from usb_relay_device_open()
      - Index: integer from 1 to the maximal number of channels on a board.
   
- * usb_relay_device_open_all_relay_channel
+ * `usb_relay_device_open_all_relay_channel`
   Turns ON all channels on a board.
   
- * usb_relay_device_close_one_relay_channel
+ * `usb_relay_device_close_one_relay_channel`
   Turns OFF one channel of a Relay board.
   Parameters: 
-     - device handle, obtained from usb_relay_device_open()
+     - device handle, obtained from `usb_relay_device_open()`
      - Index: integer from 1 to the maximal number of channels on a board.
 
- * usb_relay_device_close_all_relay_channel()
+ * `usb_relay_device_close_all_relay_channel`
   Turns OFF all channels on a board.
  
- * usb_relay_device_get_status
+ * `usb_relay_device_get_status`
   Get status of all channels on a board as a bit mask.
   The least significant bit in returned value corresponds to channel 1.
   Bit value 1 means the corresponding relay is switched ON, value 0 means the relay is OFF.
   
- * usb_relay_device_close
-  Closes the Relay device handle opened by usb_relay_device_open() or
-   usb_relay_device_open_with_serial_number()
+ * `usb_relay_device_close`
+  Closes the Relay device handle opened by `usb_relay_device_open()` or
+   `usb_relay_device_open_with_serial_number()`
  
- * usb_relay_exit 
+* `usb_relay_exit`
   Finalizes the library
 
 Error handling