walkero
/
libpsl
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

added docs for psl_error_t

This commit is contained in:
Tim Ruehsen 2014-06-20 17:12:17 +02:00
parent f7f1408088
commit 29a74ebe3a
2 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/libpsl/libpsl-sections.txt
View File

@ -1,6 +1,7 @@
<SECTION> <SECTION>
<FILE>libpsl</FILE> <FILE>libpsl</FILE>
<TITLE>Public Suffix List functions</TITLE> <TITLE>Public Suffix List functions</TITLE>
psl_error_t
psl_ctx_t psl_ctx_t
psl_load_file psl_load_file
psl_load_fp psl_load_fp

13
include/libpsl.h
View File

@ -38,6 +38,19 @@
extern "C" { extern "C" {
#endif #endif
/**
* psl_error_t:
* @PSL_SUCCESS: Successful return.
* @PSL_ERR_INVALID_ARG: Invalid argument.
* @PSL_ERR_CONVERTER: Failed to open libicu utf-16 converter
* @PSL_ERR_TO_UTF16: Failed to convert to utf-16.
* @PSL_ERR_TO_LOWER: Failed to convert utf-16 to lowercase.
* @PSL_ERR_TO_UTF8: Failed to convert utf-16 to utf-8.
*
* Return codes for PSL functions.
* Negative return codes mean failure.
* Positive values are reserved for non-error return codes.
*/
typedef enum { typedef enum {
PSL_SUCCESS = 0, PSL_SUCCESS = 0,
PSL_ERR_INVALID_ARG = -1, PSL_ERR_INVALID_ARG = -1,