X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Fidzebra%2Fdict.h;h=8a2828b2418b700a4795da773f755bee34ccf8fd;hb=997db1975fa2132c9bb155b69c86f1310f5136b4;hp=5dc9e2b8d75b10c64c6313d2bd08f9cd9b3fb07d;hpb=05b9b8ed020c5bfa48a913d6a2e2b50ddf1bab8e;p=idzebra-moved-to-github.git

diff --git a/include/idzebra/dict.h b/include/idzebra/dict.h
index 5dc9e2b..8a2828b 100644
--- a/include/idzebra/dict.h
+++ b/include/idzebra/dict.h
@@ -1,6 +1,6 @@
-/* $Id: dict.h,v 1.1 2004-12-08 12:23:09 adam Exp $
-   Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
-   Index Data Aps
+/* $Id: dict.h,v 1.5 2006-05-10 08:13:20 adam Exp $
+   Copyright (C) 1995-2005
+   Index Data ApS
 
 This file is part of the Zebra server.
 
@@ -20,14 +20,27 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 02111-1307, USA.
 */
 
+/** \file dict.h
+    \brief Zebra dictionary
+    
+    The dictionary is a hash that maps a string to a value.
+    The value is opaque and is defined as a sequence of bytes
+    with a length in the range 0 to 255.
+*/
+
 #ifndef DICT_H
 #define DICT_H
 
-#include <yaz/ylog.h>
+#include <yaz/yconfig.h>
 #include <idzebra/bfile.h>
 
 YAZ_BEGIN_CDECL
 
+/** \var Dict
+ * \brief Dictionary type
+ *
+ * Most dictionary functions operatate on a Dict type (object).
+ */
 typedef struct Dict_struct *Dict;
 
 typedef unsigned Dict_ptr;
@@ -85,3 +98,11 @@ int dict_copy_compact (BFiles bfs, const char *from, const char *to);
 YAZ_END_CDECL
    
 #endif
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+