-/* $Id: dict.h,v 1.3 2005-01-15 19:38:24 adam Exp $
- Copyright (C) 1995-2005
+/* $Id: dict.h,v 1.6 2006-08-14 10:40:14 adam Exp $
+ Copyright (C) 1995-2006
Index Data ApS
This file is part of the Zebra server.
for more details.
You should have received a copy of the GNU General Public License
-along with Zebra; see the file LICENSE.zebra. If not, write to the
-Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-02111-1307, USA.
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 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
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;
YAZ_END_CDECL
#endif
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+