emil/libhl
1
3
Fork 0
Code Issues Pull Requests Releases Wiki Activity

minor doc edit

Browse Source
This commit is contained in:
anon 2023-09-20 22:42:06 +02:00
parent 5032e2aabb
commit dcdd3abb8c
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -32,9 +32,9 @@ Fit a specific token against a string. `render_string()` uses this function inte
typedef void (*attribute_callback_t)(const char * const string, const int length, void * const attributes);
```
The type used for defining appropriate callbacks for render\_string().
+ string - string to be outputed
+ length - number of characters that matched a highlighting rule
+ attributes - arbitrary data associated with the matched rule; intended to hold color/font information for example
+ string - string to be processed (probably printed)
+ length - number of characters to be processed from _string_
+ attributes - arbitrary data associated with the matched token; intended to hold color/font information for example; if no token was matched NULL will be passed
```C