diff options
| author | joe <joe@61a7d7f5-40b7-0310-9c16-bb0ea8cb1845> | 2006-01-06 14:05:40 +0000 |
|---|---|---|
| committer | joe <joe@61a7d7f5-40b7-0310-9c16-bb0ea8cb1845> | 2006-01-06 14:05:40 +0000 |
| commit | 504f4e048dd0d3eaca9af31b1e448f43f90df2a8 (patch) | |
| tree | 67dc3709d833d628db8e2f936a4b75403da7000a /src/ne_i18n.h | |
| parent | fd5a068a55209fe51829617b047784d125ee628d (diff) | |
| download | neon-504f4e048dd0d3eaca9af31b1e448f43f90df2a8.tar.gz | |
* src/ne_i18n.h: Expand on use of ne_i18n_init a little.
git-svn-id: http://svn.webdav.org/repos/projects/neon/trunk@828 61a7d7f5-40b7-0310-9c16-bb0ea8cb1845
Diffstat (limited to 'src/ne_i18n.h')
| -rw-r--r-- | src/ne_i18n.h | 33 |
1 files changed, 22 insertions, 11 deletions
diff --git a/src/ne_i18n.h b/src/ne_i18n.h index a3c7f66..b6dd219 100644 --- a/src/ne_i18n.h +++ b/src/ne_i18n.h @@ -1,6 +1,6 @@ /* Internationalization of neon - Copyright (C) 2005, Joe Orton <joe@manyfish.co.uk> + Copyright (C) 2005-2006, Joe Orton <joe@manyfish.co.uk> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public @@ -26,17 +26,28 @@ NE_BEGIN_DECLS -/* Initialize translated error messages within neon. This call is - * strictly only necessary if this copy of the neon library has been - * installed into a different prefix than the gettext() implementation - * on which it depends for i18n purposes. If this call is not made, - * the message catalogs will not be found in that case, but the - * library will operate otherwise correctly (albeit giving - * English-only error messages). +/* Initialize translated error messages within neon. If 'encoding' is + * non-NULL, it specifies the character encoding for the generated + * translated strings. If it is NULL, the appropriate character + * encoding for the locale will be used. * - * If 'encoding' is non-NULL, it specifies the character encoding for - * the generated translated strings. If it is NULL, the appropriate - * character encoding for the locale will be used. */ + * This call is only strictly necessary if either: + * + * a) neon has been installed into a different prefix than the + * gettext() implementation on which it depends for i18n purposes, or + * + * b) the caller requires that translated messages are in a particular + * character encoding. + * + * If ne_i18n_init() is never called, the message catalogs will not be + * found if case (a) applies (and so English error messages will be + * used), and will use the default character encoding specified by the + * process locale. The library will otherwise operate correctly. + * + * Note that the encoding used is a process-global setting and so + * results may be unexpected if other users of neon within the process + * call ne_i18n_init() with a different encoding parameter. + */ void ne_i18n_init(const char *encoding); NE_END_DECLS |