Comment
authorAdam Dickmeiss <adam@indexdata.dk>
Wed, 5 Mar 2008 09:15:04 +0000 (09:15 +0000)
committerAdam Dickmeiss <adam@indexdata.dk>
Wed, 5 Mar 2008 09:15:04 +0000 (09:15 +0000)
index/recindex.h

index 0376f6d..3676941 100644 (file)
@@ -1,5 +1,5 @@
-/* $Id: recindex.h,v 1.33 2007-11-28 11:16:32 adam Exp $
-   Copyright (C) 1995-2007
+/* $Id: recindex.h,v 1.34 2008-03-05 09:15:04 adam Exp $
+   Copyright (C) 1995-2008
    Index Data ApS
 
 This file is part of the Zebra server.
@@ -109,7 +109,16 @@ enum {
 
 typedef struct recindex *recindex_t;
 
+/** \brief opens record index handle
+    \param bfs Block files handle
+    \param rw 1 for read and write; 0 for read-only
+    \param use_isamb 1 if ISAMB is to used for record index; 0 for flat (old)
+*/
 recindex_t recindex_open(BFiles bfs, int rw, int use_isamb);
+
+/** \brief closes record index handle
+    \param p records handle
+*/
 void recindex_close(recindex_t p);
 int recindex_read_head(recindex_t p, void *buf);
 const char *recindex_get_fname(recindex_t p);