comments added and repaired

diff --git a/source/din_spi.c b/source/din_spi.c
index 43192a11359bd78046f54699c30e48721ff31520..d00990547f344ec28ccd9101c2dbc7af7b12d6f2 100644 (file)
--- a/source/din_spi.c
+++ b/source/din_spi.c
@@ -60,7 +60,8 @@ void din_set_pr(uint8_t word) {
 
 /**
  * Set DIN pins to be tri-state (1) or Active (0)
- * @param word 16-bit array represating state. First 8-bits = SP0-7, last 8-bits = SG0-7
+ * @param sp_state 16-bit variable representing state of SP pins. (0 - active, 1 - tri-state).
+ * @param sg_state 16-bit variable representing state of SP pins. (0 - active, 1 - tri-state).
  */
 void din_set_stat(uint16_t sp_state, uint16_t sg_state) {
        int i;
@@ -90,7 +91,8 @@ void din_set_stat(uint16_t sp_state, uint16_t sg_state) {
 
 /**
  * Enable/disable interrupts for DIN pins as well as acting pins as wake-up
- * @param word 16-bit array representing interrupt enablers. First 8-bits = SP0-7, last 8-bits = SG0-7
+ * @param sp_int_enable        16-bit variable representing interrupt enablers for SP pins (0 - disable wake-up and interrupt, 1 - enable interrupt).
+ * @param sg_int_enable 16-bit variable representing interrupt enablers for SG pins (0 - disable wake-up and interrupt, 1 - enable interrupt).
  */
 void din_set_int(uint16_t sp_int_enable, uint16_t sg_int_enable) {
        int i;
@@ -172,6 +174,7 @@ int din_spi_transfer_mst() {
  * In the end send other commands
  *
  * Store response from spi
+ * Returns spi response
  */
 int din_spi_transfer() {
        if (transfer_state_cmd) {
@@ -189,10 +192,18 @@ int din_spi_transfer() {
        return din_spi_transfer_mst();
 }
 
+/**
+ * Get latest response from SPI. Function does not send anything.
+ * @return latest spi response
+ */
 int din_spi_response() {
        return din_spi_resp;
 }
 
+/**
+ * Get last command sent on SPI
+ * @return latest sent command
+ */
 int din_spi_get_cmd() {
        return din_spi_cmd;
 }