annotate librcd/librcd.h @ 2059:8aaf0f145578 trunk

[svn] - documentation fixups
author nenolod
date Mon, 04 Dec 2006 18:30:58 -0800
parents 9becbe564217
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1613
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
1 #ifndef _LIBRCD_H
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
2 #define _LIBRCD_H
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
3
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
4 #ifdef __cplusplus
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
5 extern "C" {
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
6 #endif
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
7
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
8 enum rcd_russian_charset_t {
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
9 RUSSIAN_CHARSET_WIN = 0,
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
10 RUSSIAN_CHARSET_KOI,
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
11 RUSSIAN_CHARSET_UTF8,
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
12 RUSSIAN_CHARSET_ALT
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
13 };
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
14 typedef enum rcd_russian_charset_t rcd_russian_charset;
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
15
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
16
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
17 /*
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
18 rcdGetRussianCharset
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
19 Detects encoding of russian text passed in buf variable. Support
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
20 UTF-8, CP1251, CP866 and KOI8-R encoding.
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
21
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
22 buf String with russian texts
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
23 len Number of bytes to use from buf. If zero is passed determined
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
24 by strlen.
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
25
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
26 Returns:
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
27 0 - CP1251
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
28 1 - KOI8-R
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
29 2 - UTF8
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
30 3 - CP866
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
31 */
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
32
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
33 rcd_russian_charset rcdGetRussianCharset(const char *buf, int len);
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
34
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
35 #ifdef __cplusplus
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
36 }
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
37 #endif
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
38
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
39 /* Backward compatibility */
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
40 #ifndef _LIBRCD_C
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
41 # define russian_charsets rcd_russian_charset_t
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
42 # define get_russian_charset rcdGetRussianCharset
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
43 #endif /* ! _LIBRCD_C */
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
44
9becbe564217 [svn] - chardet patch for Russian language witten by Valentine Sinitsyn.
yaz
parents:
diff changeset
45 #endif /* _LIBRCD_H */