summaryrefslogtreecommitdiff
path: root/utils/messages.h
diff options
context:
space:
mode:
authorJames Bursa <james@netsurf-browser.org>2004-05-08 18:13:27 +0000
committerJames Bursa <james@netsurf-browser.org>2004-05-08 18:13:27 +0000
commit7356aa96c9c2332b9d3fe35f8e48b2c403620b08 (patch)
treefc0763faf52d513ea168927e6dc2c237d5960624 /utils/messages.h
parentb148ed230f5b497bdc614462828aa5e634298e59 (diff)
downloadnetsurf-7356aa96c9c2332b9d3fe35f8e48b2c403620b08.tar.gz
netsurf-7356aa96c9c2332b9d3fe35f8e48b2c403620b08.tar.bz2
[project @ 2004-05-08 18:13:27 by bursa]
Clean up and make more efficient. svn path=/import/netsurf/; revision=843
Diffstat (limited to 'utils/messages.h')
-rw-r--r--utils/messages.h17
1 files changed, 9 insertions, 8 deletions
diff --git a/utils/messages.h b/utils/messages.h
index fd8457da8..bef380edc 100644
--- a/utils/messages.h
+++ b/utils/messages.h
@@ -2,19 +2,20 @@
* This file is part of NetSurf, http://netsurf.sourceforge.net/
* Licensed under the GNU General Public License,
* http://www.opensource.org/licenses/gpl-license
- * Copyright 2003 James Bursa <bursa@users.sourceforge.net>
+ * Copyright 2004 James Bursa <bursa@users.sourceforge.net>
*/
-/**
+/** \file
+ * Localised message support (interface).
+ *
* The messages module loads a file of keys and associated strings, and
* provides fast lookup by key. The messages file consists of key:value lines,
* comment lines starting with #, and other lines are ignored. Use
- * messages_load() to read the file into memory. To lookup a key, use
- * messages_get("key") or messages_get("key:fallback") . A pointer to the
- * value is returned, and this is shared by all callers. If the key does not
- * exist, the parameter will be returned in the first case and a pointer to
- * the fallback string in the parameter in the second. Thus the parameter must
- * be a constant string.
+ * messages_load() to read the file into memory. To lookup a key, use
+ * messages_get("key").
+ *
+ * Only the first MAX_KEY_LENGTH (currently 16) characters of the key are
+ * significant.
*/
#ifndef _NETSURF_UTILS_MESSAGES_H_