From: Adam Dickmeiss <adam@indexdata.dk>
Date: Tue, 23 Oct 2007 12:36:22 +0000 (+0000)
Subject: Doxygen.
X-Git-Tag: ZEBRA.2.0.20~108
X-Git-Url: http://jsfdemo.indexdata.com/cgi-bin?a=commitdiff_plain;h=d4999f503a4d90db9a7777a2da2bb58cff1823a5;p=idzebra-moved-to-github.git

Doxygen.
---

diff --git a/include/index_rules.h b/include/index_rules.h
index 5966842..32cbd7d 100644
--- a/include/index_rules.h
+++ b/include/index_rules.h
@@ -1,4 +1,4 @@
-/* $Id: index_rules.h,v 1.1 2007-10-23 12:26:25 adam Exp $
+/* $Id: index_rules.h,v 1.2 2007-10-23 12:36:22 adam Exp $
    Copyright (C) 1995-2007
    Index Data ApS
 
@@ -21,6 +21,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
 /** 
+    \file index_rules.h
     \brief Definitions for Zebra's index rules system
 */
 
@@ -32,6 +33,9 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
 YAZ_BEGIN_CDECL
 
+/**
+   \brief zebra index rules handle (ptr)
+*/
 typedef struct zebra_index_rules_s *zebra_index_rules_t;
 
 /** \brief creates index rules handler/object from file
@@ -65,7 +69,7 @@ void zebra_index_rules_destroy(zebra_index_rules_t r);
 
 
 /** \brief creates index rules handler/object from xml Doc
-    \param fname filename
+    \param doc Libxml2 document
     \returns handle (NULL if unsuccessful)
 
     Similar to zebra_index_rules_create
diff --git a/include/rob_regexp.h b/include/rob_regexp.h
index 31281ae..7d81e1c 100644
--- a/include/rob_regexp.h
+++ b/include/rob_regexp.h
@@ -1,4 +1,4 @@
-/* $Id: rob_regexp.h,v 1.1 2007-10-23 12:26:25 adam Exp $
+/* $Id: rob_regexp.h,v 1.2 2007-10-23 12:36:22 adam Exp $
    Copyright (C) 1995-2007
    Index Data ApS
 
@@ -21,7 +21,8 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
 /** 
-    \brief Definitions for Zebra's index rules system
+    \file rob_regexp.h
+    \brief Rob Pike's regular expression matcher
 */
 
 #ifndef ZEBRA_ROB_REGEXP_H
@@ -31,6 +32,15 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
 YAZ_BEGIN_CDECL
 
+/** \brief matches a regular expression against text
+    \param regexp regular expression
+    \param text the text
+    \retval 0 no match
+    \retval 1 match
+
+    Operators: c (literal char), . (any char), ^ (begin), $ (end),
+    * (zero or more)
+*/
 int zebra_rob_regexp(const char *regexp, const char *text);
 
 YAZ_END_CDECL
diff --git a/util/rob_regexp.c b/util/rob_regexp.c
index 042eb10..93b0f78 100644
--- a/util/rob_regexp.c
+++ b/util/rob_regexp.c
@@ -1,4 +1,4 @@
-/* $Id: rob_regexp.c,v 1.1 2007-10-23 12:26:26 adam Exp $
+/* $Id: rob_regexp.c,v 1.2 2007-10-23 12:36:22 adam Exp $
    Copyright (C) 1995-2007
    Index Data ApS
 
@@ -21,7 +21,8 @@
 */
 
 /** 
-    \brief Rob Pike's regular expresion parser
+    \file rob_regexp.c
+    \brief Rob Pike's regular expression matcher
     
     Taken verbatim from Beautiful code.. ANSIfied a bit.
  */