Update copyright year + FSF address

[idzebra-moved-to-github.git] / include / idzebra / util.h

diff --git a/include/idzebra/util.h b/include/idzebra/util.h
index dab4490..5952655 100644 (file)
--- a/include/idzebra/util.h
+++ b/include/idzebra/util.h
@@ -1,5 +1,5 @@
-/* $Id: util.h,v 1.2 2005-04-15 10:47:48 adam Exp $
-   Copyright (C) 1995-2005
+/* $Id: util.h,v 1.8 2006-08-14 10:40:14 adam Exp $
+   Copyright (C) 1995-2006
    Index Data ApS
 
 This file is part of the Zebra server.
@@ -15,9 +15,9 @@ FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 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
+
 */
 
 #ifndef ZEBRA_UTIL_H
@@ -35,6 +35,13 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 
 YAZ_BEGIN_CDECL
 
+/** \var zint
+ * \brief Zebra integer
+ *
+ * This integer is used in various Zebra APIs to specify record identifires,
+ * number of occurrences etc. It is a "large" integer and is usually
+ * 64-bit on newer architectures.
+ */
 #ifdef __GNUC__
 typedef long long int zint;
 #define ZINT_FORMAT "%lld"
@@ -51,6 +58,12 @@ typedef long zint;
 #endif
 #endif
 
+/** \var typedef ZEBRA_RES
+ * \brief Common return type for Zebra API
+ *
+ * This return code indicates success with code ZEBRA_OK and failure
+ * with ZEBRA_FAIL
+ */
 typedef short ZEBRA_RES;
 #define ZEBRA_FAIL -1
 #define ZEBRA_OK   0
@@ -72,3 +85,11 @@ YAZ_END_CDECL
 #define CAST_ZINT_TO_DOUBLE(x) (double)(x)
 
 #endif
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+