From a59b1c9571e45b7143214334075ca8484aad9d86 Mon Sep 17 00:00:00 2001 From: Jehan Date: Wed, 21 Sep 2016 17:35:34 +0200 Subject: [PATCH] src: update documentation comments on the public API. --- src/uchardet.h | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/src/uchardet.h b/src/uchardet.h index c1593eb..0ad1de1 100644 --- a/src/uchardet.h +++ b/src/uchardet.h @@ -20,6 +20,7 @@ * * Contributor(s): * BYVoid + * Jehan * * 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 @@ -43,22 +44,29 @@ extern "C" { #include +/** + * A handle for a uchardet encoding detector. + */ typedef struct uchardet * uchardet_t; /** * Create an encoding detector. - * @return a handle of a instance of uchardet + * @return an instance of uchardet_t. */ uchardet_t uchardet_new(void); /** * 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); /** * 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 data [in] data * @param len [in] number of byte of data