]> rtime.felk.cvut.cz Git - pes-rpp/rpp-lib.git/commitdiff
din: Update documentation
authorMichal Sojka <sojkam1@fel.cvut.cz>
Thu, 14 Apr 2016 14:53:17 +0000 (16:53 +0200)
committerMichal Sojka <sojkam1@fel.cvut.cz>
Thu, 14 Apr 2016 14:53:17 +0000 (16:53 +0200)
- clarification
- typos

rpp/include/rpp/din.h

index 7c6a81bcb5c51992a10c8f09d9e9b8ad39bfec19..e86e387148dc1bffcc28aaae60a5a2b8969ff48f 100644 (file)
@@ -3,7 +3,7 @@
  *
  * @file din.h
  *
- * @copyright Copyright (C) 2013 Czech Technical University in Prague
+ * @copyright Copyright (C) 2013, 2016 Czech Technical University in Prague
  *
  * @author Carlos Jenkins <carlos@jenkins.co.cr>
  */
@@ -56,8 +56,9 @@ int8_t rpp_din_ref(uint16_t refA, uint16_t refB);
  *                      Note that pins [8-15] are pull-down only.
  * @param[in] active    TRUE to setup pin as active or FALSE to set it as
  *                      tri-stated.
- * @param[in] can_wake  TRUE is given pin can wake module from sleep state and
- *                      trigger an interrupt on MCU. FALSE otherwise.
+ * @param[in] can_wake  TRUE if the given pin can wake the module from
+ *                      sleep state and trigger an interrupt on MCU.
+ *                      FALSE otherwise.
  *
  * @return SUCCESS if successful.\n
  *         -1 if pin number is out of range.\n