Omit CVS Id. Update copyright year.

[idzebra-moved-to-github.git] / index / recindex.h

diff --git a/index/recindex.h b/index/recindex.h
index 0376f6d..d353c3c 100644 (file)
--- a/index/recindex.h
+++ b/index/recindex.h
@@ -1,8 +1,5 @@
-/* $Id: recindex.h,v 1.33 2007-11-28 11:16:32 adam Exp $
-   Copyright (C) 1995-2007
-   Index Data ApS
-
-This file is part of the Zebra server.
+/* This file is part of the Zebra server.
+   Copyright (C) 1995-2008 Index Data
 
 Zebra is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free
@@ -109,7 +106,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);