kingkevin
/
clapperboard
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fix documentation

This commit is contained in:
King Kévin 2017-02-09 12:34:59 +01:00
parent 1dbfbe3841
commit 9c5c535e85
3 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lib/i2c.h
View File

@ -16,7 +16,7 @@
* @file i2c.h
* @author King Kévin <kingkevin@cuvoodoo.info>
* @date 2017
* @note peripherals used: I2C @ref i2c_i2c, timer @i2c_timer
* @note peripherals used: I2C @ref i2c_i2c, timer @ref i2c_timer
*/
#pragma once
@ -29,7 +29,7 @@ void i2c_master(bool fast);
* @param[in] address memory address of slave to read from
* @param[in] address_size address size in bytes
* @param[out] data array to store bytes read
* @pramr[in] data_size number of bytes to read
* @param[in] data_size number of bytes to read
* @return if read succeeded
*/
bool i2c_read(uint8_t slave, const uint8_t* address, size_t address_size, uint8_t* data, size_t data_size);
@ -38,7 +38,7 @@ bool i2c_read(uint8_t slave, const uint8_t* address, size_t address_size, uint8_
* @param[in] address memory address of slave to write to
* @param[in] address_size address size in bytes
* @param[in] data array of byte to write to slave
* @pramr[in] data_size number of bytes to write
* @param[in] data_size number of bytes to write
* @return if write succeeded
*/
bool i2c_write(uint8_t slave, const uint8_t* address, size_t address_size, const uint8_t* data, size_t data_size);

4
lib/led_tm1637.c
View File

@ -21,11 +21,11 @@
* @warning all calls are blocking
*
* bit vs segment: 0bpgfedcba
* /a\
* +a+
* f b p
* +g+
* e c p
* \b/
* +b+
*/
/* standard libraries */

6
lib/rtc_ds1307.h
View File

@ -16,7 +16,7 @@
* @file rtc_ds1307.h
* @author King Kévin <kingkevin@cuvoodoo.info>
* @date 2016-2017
* @note peripherals used: I2C @ref rtc_ds1307_i2c
* @note peripherals used: I2C @ref i2c_i2c
*/
#pragma once
@ -67,7 +67,7 @@ uint8_t* rtc_ds1307_read_time(void);
/** read user RAM from RTC IC
* @param[out] data array to store the RAM read
* @param[in] start start of the user RAM to read (0-55)
* @pramr[in] length number of user RAM bytes to read (0-55)
* @param[in] length number of user RAM bytes to read (0-55)
* @return if read succeeded
*/
bool rtc_ds1307_read_ram(uint8_t* data, uint8_t start, uint8_t length);
@ -133,7 +133,7 @@ bool rtc_ds1307_write_time(uint8_t seconds, uint8_t minutes, uint8_t hours, uint
/** write user RAM from RTC IC
* @param[in] data array of byte to write in RAM
* @param[in] start start of the user RAM to write (0-55)
* @pramr[in] length number of user RAM bytes to write (0-55)
* @param[in] length number of user RAM bytes to write (0-55)
* @return if write succeeded
*/
bool rtc_ds1307_write_ram(uint8_t* data, uint8_t start, uint8_t length);