coffee/uchardet
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/uchardet/uchardet.git synced 2025-12-06 16:56:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

src: update documentation comments on the public API.

Browse Source
This commit is contained in:
Jehan 2016-09-21 17:35:34 +02:00
parent 3401ac70d0
commit a59b1c9571
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/uchardet.h
View File

@ -20,6 +20,7 @@
* *
* Contributor(s): * Contributor(s):
* BYVoid <byvoid.kcp@gmail.com> * BYVoid <byvoid.kcp@gmail.com>
* Jehan <jehan at girinstud.io>
* *
* Alternatively, the contents of this file may be used under the terms of * Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or * either the GNU General Public License Version 2 or later (the "GPL"), or
@ -43,22 +44,29 @@ extern "C" {
#include <stddef.h> #include <stddef.h>
/**
* A handle for a uchardet encoding detector.
*/
typedef struct uchardet * uchardet_t; typedef struct uchardet * uchardet_t;
/** /**
* Create an encoding detector. * Create an encoding detector.
* @return a handle of a instance of uchardet * @return an instance of uchardet_t.
*/ */
uchardet_t uchardet_new(void); uchardet_t uchardet_new(void);
/** /**
* Delete an encoding detector. * Delete an encoding detector.
* @param ud [in] handle of a instance of uchardet * @param ud [in] the uchardet_t handle to delete.
*/ */
void uchardet_delete(uchardet_t ud); void uchardet_delete(uchardet_t ud);
/** /**
* Feed data to an encoding detector. * Feed data to an encoding detector.
* The detector is able to shortcut processing when it reaches certainty
* for an encoding, so you should not worry about limiting input data.
* As far as you should be concerned: the more the better.
*
* @param ud [in] handle of a instance of uchardet * @param ud [in] handle of a instance of uchardet
* @param data [in] data * @param data [in] data
* @param len [in] number of byte of data * @param len [in] number of byte of data