Skip to content

Commit c134cc6

Browse files
libdriverlibdriver
authored
Merge pull request #21 from libdriver/dev
fix: fix doc errors
2 parents aa96480 + 605a433 commit c134cc6

File tree

14 files changed

+175
-169
lines changed

14 files changed

+175
-169
lines changed

‎CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## 1.0.4 (2025-03-02)
2+
3+
## Bug Fixes
4+
5+
- fix doc errors
6+
17
## 1.0.3 (2025-01-05)
28

39
## Bug Fixes

‎project/raspberrypi4b/interface/inc/iic.h

+31-31
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ extern "C" {
5555

5656
/**
5757
* @brief iic bus init
58-
* @param[in] *name points to an iic device name buffer
59-
* @param[out] *fd points to an iic device handle buffer
58+
* @param[in] *name pointer to an iic device name buffer
59+
* @param[out] *fd pointer to an iic device handle buffer
6060
* @return status code
6161
* - 0 success
6262
* - 1 init failed
@@ -66,7 +66,7 @@ uint8_t iic_init(char *name, int *fd);
6666

6767
/**
6868
* @brief iic bus deinit
69-
* @param[in] fd is the iic handle
69+
* @param[in] fd iic handle
7070
* @return status code
7171
* - 0 success
7272
* - 1 deinit failed
@@ -76,10 +76,10 @@ uint8_t iic_deinit(int fd);
7676

7777
/**
7878
* @brief iic bus read command
79-
* @param[in] fd is the iic handle
80-
* @param[in] addr is the iic device write address
81-
* @param[out] *buf points to a data buffer
82-
* @param[in] len is the length of the data buffer
79+
* @param[in] fd iic handle
80+
* @param[in] addr iic device write address
81+
* @param[out] *buf pointer to a data buffer
82+
* @param[in] len length of the data buffer
8383
* @return status code
8484
* - 0 success
8585
* - 1 read failed
@@ -89,11 +89,11 @@ uint8_t iic_read_cmd(int fd, uint8_t addr, uint8_t *buf, uint16_t len);
8989

9090
/**
9191
* @brief iic bus read
92-
* @param[in] fd is the iic handle
93-
* @param[in] addr is the iic device write address
94-
* @param[in] reg is the iic register address
95-
* @param[out] *buf points to a data buffer
96-
* @param[in] len is the length of the data buffer
92+
* @param[in] fd iic handle
93+
* @param[in] addr iic device write address
94+
* @param[in] reg iic register address
95+
* @param[out] *buf pointer to a data buffer
96+
* @param[in] len length of the data buffer
9797
* @return status code
9898
* - 0 success
9999
* - 1 read failed
@@ -103,11 +103,11 @@ uint8_t iic_read(int fd, uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);
103103

104104
/**
105105
* @brief iic bus read with 16 bits register address
106-
* @param[in] fd is the iic handle
107-
* @param[in] addr is the iic device write address
108-
* @param[in] reg is the iic register address
109-
* @param[out] *buf points to a data buffer
110-
* @param[in] len is the length of the data buffer
106+
* @param[in] fd iic handle
107+
* @param[in] addr iic device write address
108+
* @param[in] reg iic register address
109+
* @param[out] *buf pointer to a data buffer
110+
* @param[in] len length of the data buffer
111111
* @return status code
112112
* - 0 success
113113
* - 1 read failed
@@ -117,10 +117,10 @@ uint8_t iic_read_address16(int fd, uint8_t addr, uint16_t reg, uint8_t *buf, uin
117117

118118
/**
119119
* @brief iic bus write command
120-
* @param[in] fd is the iic handle
121-
* @param[in] addr is the iic device write address
122-
* @param[in] *buf points to a data buffer
123-
* @param[in] len is the length of the data buffer
120+
* @param[in] fd iic handle
121+
* @param[in] addr iic device write address
122+
* @param[in] *buf pointer to a data buffer
123+
* @param[in] len length of the data buffer
124124
* @return status code
125125
* - 0 success
126126
* - 1 write failed
@@ -130,11 +130,11 @@ uint8_t iic_write_cmd(int fd, uint8_t addr, uint8_t *buf, uint16_t len);
130130

131131
/**
132132
* @brief iic bus write
133-
* @param[in] fd is the iic handle
134-
* @param[in] addr is the iic device write address
135-
* @param[in] reg is the iic register address
136-
* @param[in] *buf points to a data buffer
137-
* @param[in] len is the length of the data buffer
133+
* @param[in] fd iic handle
134+
* @param[in] addr iic device write address
135+
* @param[in] reg iic register address
136+
* @param[in] *buf pointer to a data buffer
137+
* @param[in] len length of the data buffer
138138
* @return status code
139139
* - 0 success
140140
* - 1 write failed
@@ -144,11 +144,11 @@ uint8_t iic_write(int fd, uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len)
144144

145145
/**
146146
* @brief iic bus write with 16 bits register address
147-
* @param[in] fd is the iic handle
148-
* @param[in] addr is the iic device write address
149-
* @param[in] reg is the iic register address
150-
* @param[in] *buf points to a data buffer
151-
* @param[in] len is the length of the data buffer
147+
* @param[in] fd iic handle
148+
* @param[in] addr iic device write address
149+
* @param[in] reg iic register address
150+
* @param[in] *buf pointer to a data buffer
151+
* @param[in] len length of the data buffer
152152
* @return status code
153153
* - 0 success
154154
* - 1 write failed

‎project/raspberrypi4b/interface/src/gpio.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ extern uint8_t (*g_gpio_irq)(void); /**< gpio irq */
5858

5959
/**
6060
* @brief gpio interrupt pthread
61-
* @param *p ponts to an args buffer
61+
* @param *p pointer to an args buffer
6262
* @return NULL
6363
* @note none
6464
*/

‎project/raspberrypi4b/interface/src/iic.c

+31-31
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@
4242

4343
/**
4444
* @brief iic bus init
45-
* @param[in] *name points to an iic device name buffer
46-
* @param[out] *fd points to an iic device handle buffer
45+
* @param[in] *name pointer to an iic device name buffer
46+
* @param[out] *fd pointer to an iic device handle buffer
4747
* @return status code
4848
* - 0 success
4949
* - 1 init failed
@@ -69,7 +69,7 @@ uint8_t iic_init(char *name, int *fd)
6969

7070
/**
7171
* @brief iic bus deinit
72-
* @param[in] fd is the iic handle
72+
* @param[in] fd iic handle
7373
* @return status code
7474
* - 0 success
7575
* - 1 deinit failed
@@ -92,10 +92,10 @@ uint8_t iic_deinit(int fd)
9292

9393
/**
9494
* @brief iic bus read command
95-
* @param[in] fd is the iic handle
96-
* @param[in] addr is the iic device write address
97-
* @param[out] *buf points to a data buffer
98-
* @param[in] len is the length of the data buffer
95+
* @param[in] fd iic handle
96+
* @param[in] addr iic device write address
97+
* @param[out] *buf pointer to a data buffer
98+
* @param[in] len length of the data buffer
9999
* @return status code
100100
* - 0 success
101101
* - 1 read failed
@@ -133,11 +133,11 @@ uint8_t iic_read_cmd(int fd, uint8_t addr, uint8_t *buf, uint16_t len)
133133

134134
/**
135135
* @brief iic bus read
136-
* @param[in] fd is the iic handle
137-
* @param[in] addr is the iic device write address
138-
* @param[in] reg is the iic register address
139-
* @param[out] *buf points to a data buffer
140-
* @param[in] len is the length of the data buffer
136+
* @param[in] fd iic handle
137+
* @param[in] addr iic device write address
138+
* @param[in] reg iic register address
139+
* @param[out] *buf pointer to a data buffer
140+
* @param[in] len length of the data buffer
141141
* @return status code
142142
* - 0 success
143143
* - 1 read failed
@@ -179,11 +179,11 @@ uint8_t iic_read(int fd, uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len)
179179

180180
/**
181181
* @brief iic bus read with 16 bits register address
182-
* @param[in] fd is the iic handle
183-
* @param[in] addr is the iic device write address
184-
* @param[in] reg is the iic register address
185-
* @param[out] *buf points to a data buffer
186-
* @param[in] len is the length of the data buffer
182+
* @param[in] fd iic handle
183+
* @param[in] addr iic device write address
184+
* @param[in] reg iic register address
185+
* @param[out] *buf pointer to a data buffer
186+
* @param[in] len length of the data buffer
187187
* @return status code
188188
* - 0 success
189189
* - 1 read failed
@@ -228,10 +228,10 @@ uint8_t iic_read_address16(int fd, uint8_t addr, uint16_t reg, uint8_t *buf, uin
228228

229229
/**
230230
* @brief iic bus write command
231-
* @param[in] fd is the iic handle
232-
* @param[in] addr is the iic device write address
233-
* @param[in] *buf points to a data buffer
234-
* @param[in] len is the length of the data buffer
231+
* @param[in] fd iic handle
232+
* @param[in] addr iic device write address
233+
* @param[in] *buf pointer to a data buffer
234+
* @param[in] len length of the data buffer
235235
* @return status code
236236
* - 0 success
237237
* - 1 write failed
@@ -269,11 +269,11 @@ uint8_t iic_write_cmd(int fd, uint8_t addr, uint8_t *buf, uint16_t len)
269269

270270
/**
271271
* @brief iic bus write
272-
* @param[in] fd is the iic handle
273-
* @param[in] addr is the iic device write address
274-
* @param[in] reg is the iic register address
275-
* @param[in] *buf points to a data buffer
276-
* @param[in] len is the length of the data buffer
272+
* @param[in] fd iic handle
273+
* @param[in] addr iic device write address
274+
* @param[in] reg iic register address
275+
* @param[in] *buf pointer to a data buffer
276+
* @param[in] len length of the data buffer
277277
* @return status code
278278
* - 0 success
279279
* - 1 write failed
@@ -317,11 +317,11 @@ uint8_t iic_write(int fd, uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len)
317317

318318
/**
319319
* @brief iic bus write with 16 bits register address
320-
* @param[in] fd is the iic handle
321-
* @param[in] addr is the iic device write address
322-
* @param[in] reg is the iic register address
323-
* @param[in] *buf points to a data buffer
324-
* @param[in] len is the length of the data buffer
320+
* @param[in] fd iic handle
321+
* @param[in] addr iic device write address
322+
* @param[in] reg iic register address
323+
* @param[in] *buf pointer to a data buffer
324+
* @param[in] len length of the data buffer
325325
* @return status code
326326
* - 0 success
327327
* - 1 write failed

‎project/stm32f407/interface/inc/delay.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,14 @@ uint8_t delay_init(void);
5959

6060
/**
6161
* @brief delay us
62-
* @param[in] us
62+
* @param[in] us time
6363
* @note none
6464
*/
6565
void delay_us(uint32_t us);
6666

6767
/**
6868
* @brief delay ms
69-
* @param[in] ms
69+
* @param[in] ms time
7070
* @note none
7171
*/
7272
void delay_ms(uint32_t ms);

‎project/stm32f407/interface/inc/iic.h

+22-22
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ uint8_t iic_deinit(void);
6767

6868
/**
6969
* @brief iic bus write command
70-
* @param[in] addr is the iic device write address
71-
* @param[in] *buf points to a data buffer
72-
* @param[in] len is the length of the data buffer
70+
* @param[in] addr iic device write address
71+
* @param[in] *buf pointer to a data buffer
72+
* @param[in] len length of the data buffer
7373
* @return status code
7474
* - 0 success
7575
* - 1 write failed
@@ -79,10 +79,10 @@ uint8_t iic_write_cmd(uint8_t addr, uint8_t *buf, uint16_t len);
7979

8080
/**
8181
* @brief iic bus write
82-
* @param[in] addr is the iic device write address
83-
* @param[in] reg is the iic register address
84-
* @param[in] *buf points to a data buffer
85-
* @param[in] len is the length of the data buffer
82+
* @param[in] addr iic device write address
83+
* @param[in] reg iic register address
84+
* @param[in] *buf pointer to a data buffer
85+
* @param[in] len length of the data buffer
8686
* @return status code
8787
* - 0 success
8888
* - 1 write failed
@@ -92,10 +92,10 @@ uint8_t iic_write(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);
9292

9393
/**
9494
* @brief iic bus write with 16 bits register address
95-
* @param[in] addr is the iic device write address
96-
* @param[in] reg is the iic register address
97-
* @param[in] *buf points to a data buffer
98-
* @param[in] len is the length of the data buffer
95+
* @param[in] addr iic device write address
96+
* @param[in] reg iic register address
97+
* @param[in] *buf pointer to a data buffer
98+
* @param[in] len length of the data buffer
9999
* @return status code
100100
* - 0 success
101101
* - 1 write failed
@@ -105,9 +105,9 @@ uint8_t iic_write_address16(uint8_t addr, uint16_t reg, uint8_t *buf, uint16_t l
105105

106106
/**
107107
* @brief iic bus read command
108-
* @param[in] addr is the iic device write address
109-
* @param[out] *buf points to a data buffer
110-
* @param[in] len is the length of the data buffer
108+
* @param[in] addr iic device write address
109+
* @param[out] *buf pointer to a data buffer
110+
* @param[in] len length of the data buffer
111111
* @return status code
112112
* - 0 success
113113
* - 1 read failed
@@ -117,10 +117,10 @@ uint8_t iic_read_cmd(uint8_t addr, uint8_t *buf, uint16_t len);
117117

118118
/**
119119
* @brief iic bus read
120-
* @param[in] addr is the iic device write address
121-
* @param[in] reg is the iic register address
122-
* @param[out] *buf points to a data buffer
123-
* @param[in] len is the length of the data buffer
120+
* @param[in] addr iic device write address
121+
* @param[in] reg iic register address
122+
* @param[out] *buf pointer to a data buffer
123+
* @param[in] len length of the data buffer
124124
* @return status code
125125
* - 0 success
126126
* - 1 read failed
@@ -130,10 +130,10 @@ uint8_t iic_read(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);
130130

131131
/**
132132
* @brief iic bus read with 16 bits register address
133-
* @param[in] addr is the iic device write address
134-
* @param[in] reg is the iic register address
135-
* @param[out] *buf points to a data buffer
136-
* @param[in] len is the length of the data buffer
133+
* @param[in] addr iic device write address
134+
* @param[in] reg iic register address
135+
* @param[out] *buf pointer to a data buffer
136+
* @param[in] len length of the data buffer
137137
* @return status code
138138
* - 0 success
139139
* - 1 read failed

0 commit comments

Comments
 (0)