hummypkg
/
libxconv
4
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

improve formatting

This commit is contained in:
HummyPkg 2017-03-09 20:39:56 +00:00
parent 51d4b5656b
commit 49593acb76
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,27 +1,27 @@
# libxconv
Lightweight ISO-6937 to UTF-8 conversion library.
## SYNOPSIS
int xconv(char \*inbuf, char \*outbuf, size\_t outbuflen);
### SYNOPSIS
> int xconv(char \*inbuf, char \*outbuf, size\_t outbuflen);
## DESCRIPTION
### DESCRIPTION
The xconv() function converts a sequence of characters in ISO-6937
encoding to UTF-8.
> The xconv() function converts a sequence of characters in ISO-6937
> encoding to UTF-8.
>
> If a UTF-8 sequence is found within the input string, processing is aborted.
If a UTF-8 sequence is found within the input string, processing is aborted.
### RETURN VALUE
## RETURN VALUE
> On successful conversion, the xconv() function returns the number of
> characters placed into _outbuf_ excluding the string terminator.
>
> If no conversion is necessary (plain ASCII input string or a UTF-8 sequence
> was found) then the function returns 0. In this case, the state of the
> output buff is undefined and it should not be used.
On successful conversion, the xconv() function returns the number of
characters placed into _outbuf_ excluding the string terminator.
### NOTES
If no conversion is necessary (plain ASCII input string or a UTF-8 sequence
was found) then the function returns 0. In this case, the state of the
output buff is undefined and it should not be used.
## NOTES
This library was written to replace iconv() for a specific conversion task
in a small embedded environment with little memory or CPU time available.
> This library was written to replace iconv() for a specific conversion task
> in a small embedded environment with little memory or CPU time available.