From: Adam Dickmeiss <adam@indexdata.dk>
Date: Fri, 30 May 2008 11:55:41 +0000 (+0200)
Subject: Added a few comments. Source in ztest also analyzed by Doxygen.
X-Git-Tag: v3.0.30~27
X-Git-Url: http://lists.indexdata.dk/?a=commitdiff_plain;h=ec7571c09ddbe4580775d3a8a60271a657ae02a6;p=yaz-moved-to-github.git

Added a few comments. Source in ztest also analyzed by Doxygen.
---

diff --git a/Doxyfile.in b/Doxyfile.in
index c95c49b..ce0301a 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -477,8 +477,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = src \
-                         include
+INPUT                  = src ztest include
 
 # This tag can be used to specify the character encoding of the source files that 
 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 
diff --git a/include/yaz/sc.h b/include/yaz/sc.h
index 1889e1d..b0c1789 100644
--- a/include/yaz/sc.h
+++ b/include/yaz/sc.h
@@ -27,10 +27,9 @@
 
 /**
  * \file sc.h
- * \brief Header for Windows Service Control stuff
+ * \brief Header for Windows Service Control utility
  */
 
-
 #include <yaz/yconfig.h>
 
 YAZ_BEGIN_CDECL
diff --git a/src/icu_I18N.c b/src/icu_I18N.c
index 0bbd010..764d8f7 100644
--- a/src/icu_I18N.c
+++ b/src/icu_I18N.c
@@ -3,6 +3,11 @@
  * See the file LICENSE for details.
  */
 
+/**
+ * \file icu_I18N.c
+ * \brief ICU utilities
+ */
+
 #if HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/sc.c b/src/sc.c
index c991768..9336e60 100644
--- a/src/sc.c
+++ b/src/sc.c
@@ -3,6 +3,11 @@
  * See the file LICENSE for details.
  */
 
+/**
+ * \file sc.c
+ * \brief Windows Service Control
+ */
+
 #ifdef WIN32
 #include <windows.h>
 #include <tchar.h>
diff --git a/src/sc_test.c b/src/sc_test.c
index 025baab..05810fc 100644
--- a/src/sc_test.c
+++ b/src/sc_test.c
@@ -3,6 +3,11 @@
  * See the file LICENSE for details.
  */
 
+/**
+ * \file sc_test.c
+ * \brief Small test for the Windows Service Control utility
+ */
+
 #ifdef WIN32
 #include <windows.h>
 #include <tchar.h>
diff --git a/ztest/ztest.c b/ztest/ztest.c
index fb9fd8d..1a0579f 100644
--- a/ztest/ztest.c
+++ b/ztest/ztest.c
@@ -3,8 +3,8 @@
  * See the file LICENSE for details.
  */
 
-/*
- * Demonstration of simple server
+/** \file
+ * \brief Demonstration of server
  */
 
 #include <stdio.h>
@@ -30,8 +30,9 @@ int ztest_present(void *handle, bend_present_rr *rr);
 int ztest_esrequest(void *handle, bend_esrequest_rr *rr);
 int ztest_delete(void *handle, bend_delete_rr *rr);
 
-/** \fn get_term_hit
-    \brief use term value as hit count 
+/** \brief use term value as hit count 
+    \param s RPN structure
+    \return >= 0: search term number or -1: not found
    
     Traverse RPN tree 'in order' and use term value as hit count.
     Only terms  that looks a numeric is used.. Returns -1 if
@@ -63,8 +64,9 @@ static int get_term_hit(Z_RPNStructure *s)
     return h;
 }
 
-/** \fn get_hit_count
-    \brief gets hit count for numeric terms in RPN queries
+/** \brief gets hit count for numeric terms in RPN queries
+    \param q RPN Query
+    \return number of hits (random or number for term)
     
     This is just for testing.. A real database of course uses
     the content of a database to establish a value.. In our case, we