From: Adam Dickmeiss <adam@indexdata.dk>
Date: Sat, 15 Jan 2005 22:10:16 +0000 (+0000)
Subject: A few Doxygen doc entries
X-Git-Tag: snippet.version.1~156
X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=commitdiff_plain;h=2bd602254c9277bba8d86caf3cb97706d3939e3c

A few Doxygen doc entries
---

diff --git a/include/idzebra/api.h b/include/idzebra/api.h
index 3336ca2..c4d6411 100644
--- a/include/idzebra/api.h
+++ b/include/idzebra/api.h
@@ -1,4 +1,4 @@
-/* $Id: api.h,v 1.7 2005-01-15 21:45:43 adam Exp $
+/* $Id: api.h,v 1.8 2005-01-15 22:10:16 adam Exp $
    Copyright (C) 1995-2005
    Index Data ApS
 
@@ -70,7 +70,14 @@ typedef struct {
     char *term;          /* scan term string */
 } ZebraScanEntry;
 
+/** \var ZebraHandle
+ * \brief a Zebra Handle - (session)
+ */
 typedef struct zebra_session *ZebraHandle;
+
+/** \var ZebraService
+ * \brief a Zebra Service handle
+ */
 typedef struct zebra_service *ZebraService;
 
 
@@ -80,16 +87,40 @@ typedef struct zebra_service *ZebraService;
 
 /* Start Zebra using file 'configName' (usually zebra.cfg) */
 /* There should be exactly one ZebraService */
-YAZ_EXPORT ZebraService zebra_start (const char *configName);
-YAZ_EXPORT ZebraService zebra_start_res (const char *configName,
-				         Res def_res, Res over_res);
 
-/* Close the whole Zebra */
-YAZ_EXPORT int zebra_stop (ZebraService zs);
+/** \fn ZebraService zebra_start(const char *configName)
+ * \brief starts a Zebra service
+ * \param configName name of configuration file
+ */
+YAZ_EXPORT ZebraService zebra_start
+(const char *configName);
+
+/** \fn ZebraService zebra_start_res(const char *configName, Res def_res, Res over_res)
+ * \brief starts a Zebra service with resources
+ * \param configName name of configuration file
+ * \param def_res default resources
+ * \param over_res overriding resources
+ */
+YAZ_EXPORT
+ZebraService zebra_start_res (const char *configName,
+		         Res def_res, Res over_res);
 
-/* Report name of each record class (filter) */
-YAZ_EXPORT void zebra_filter_info(ZebraService zs, void *cd,
-				  void (*cb)(void *cd, const char *name));
+/** \fn int zebra_stop(ZebraService zs)
+ * \brief stops a Zebra service
+ * \param zs service handle
+ */
+YAZ_EXPORT
+int zebra_stop (ZebraService zs);
+
+/** \fn void zebra_filter_info(ZebraService zs, void *cd, void (*cb)(void *cd, const char *name))
+ * \brief lists enabled Zebra filters
+ * \param zs service handle
+ * \param cd callback parameter (opaque)
+ * \param cb callback function
+ */
+YAZ_EXPORT
+void zebra_filter_info(ZebraService zs, void *cd,
+		  void (*cb)(void *cd, const char *name));
 
 
 /* Open a ZebraHandle */