Skip to content

Commit 230e433

Browse files
fix some fileioc documentation
1 parent 7af7649 commit 230e433

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

src/fileioc/fileioc.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ char *ti_Detect(void **vat_ptr, const char *detect_string);
195195
* char *var_name;
196196
* void *vat_ptr = NULL;
197197
*
198-
* while ((var_name = ti_DetectVar(&vat_ptr, "my_data", TI_PRGM_TYPE)))
198+
* while ((var_name = ti_DetectVar(&vat_ptr, "my_data", OS_TYPE_PRGM)))
199199
* {
200200
* // do something with var_name or vat_ptr
201201
* }
@@ -225,7 +225,7 @@ char *ti_DetectVar(void **vat_ptr, const char *detect_string, uint8_t var_type);
225225
*
226226
* while ((var_name = ti_DetectAny(&vat_ptr, "my_data", &var_type)))
227227
* {
228-
* if (var_type == TI_PRGM_TYPE || var_type == TI_PPRGM_TYPE)
228+
* if (var_type == OS_TYPE_PRGM || var_type == OS_TYPE_PROT_PRGM)
229229
* {
230230
* // do something with var_name or vat_ptr
231231
* }
@@ -245,22 +245,22 @@ char *ti_DetectAny(void **vat_ptr, const char *detect_string, uint8_t *var_type)
245245
/**
246246
* Writes data to an AppVar/variable handle.
247247
*
248-
* @param[in] data Pointer to data structure(s).
249-
* @param[in] size Size (in bytes) of a single \p data structure.
250-
* @param[in] count Number of \p data structures to write.
248+
* @param[in] data Pointer to data element(s).
249+
* @param[in] size Size (in bytes) of a single \p data element.
250+
* @param[in] count Number of \p data elements to write.
251251
* @param[in] handle AppVar/variable handle.
252-
* @returns Number of data structures written; equals count on success.
252+
* @returns Number of data elements written; equals count on success.
253253
*/
254254
size_t ti_Write(const void *data, size_t size, size_t count, uint8_t handle);
255255

256256
/**
257257
* Reads data from an AppVar/variable handle.
258258
*
259-
* @param[out] data Pointer to data structure(s).
260-
* @param[in] size Size (in bytes) of a single \p data structure.
261-
* @param[in] count Number of \p data structures to write.
259+
* @param[out] data Pointer to data element(s).
260+
* @param[in] size Size (in bytes) of a single \p data element.
261+
* @param[in] count Number of \p data elements to read.
262262
* @param[in] handle AppVar/variable handle.
263-
* @returns Number of data structures written; equals count on success.
263+
* @returns Number of data elements written; equals count on success.
264264
*/
265265
size_t ti_Read(void *data, size_t size, size_t count, uint8_t handle);
266266

0 commit comments

Comments
 (0)