From: Adam Dickmeiss Date: Fri, 15 Oct 2004 00:18:59 +0000 (+0000) Subject: Doxyfile file description. Indentation. No change of code. X-Git-Tag: YAZ.2.0.28~23 X-Git-Url: http://lists.indexdata.dk/?a=commitdiff_plain;h=05c274ef315384faafcc5900c17468f0ea2474e6;p=yaz-moved-to-github.git Doxyfile file description. Indentation. No change of code. --- diff --git a/NEWS b/NEWS index a5b804e..79b5056 100644 --- a/NEWS +++ b/NEWS @@ -10,8 +10,8 @@ Fixed bug #172: RPM builds does not enable SSL. Doxyfile.in part of dist. Doxyfile generated by configure. -Configure aborts if --with-xml2, --with-openssl, --enable-tcpd is -given and the given component does not exist. +Configure aborts if any of --with-xml2, --with-openssl, --enable-tcpd +ares given and the given component does not exist. Extend CCL documentation in YAZ reference. Describe r=r. diff --git a/include/yaz/backend.h b/include/yaz/backend.h index 27655e0..f953637 100644 --- a/include/yaz/backend.h +++ b/include/yaz/backend.h @@ -23,7 +23,15 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: backend.h,v 1.25 2004-04-30 19:10:35 adam Exp $ + * $Id: backend.h,v 1.26 2004-10-15 00:18:59 adam Exp $ + */ + +/** + * \file backend.h + * \brief Header for GFS + * + * This header includes all public definitions for the + * Generic Frontend Server (GFS). */ #ifndef BACKEND_H diff --git a/include/yaz/ccl.h b/include/yaz/ccl.h index fc36303..d50792e 100644 --- a/include/yaz/ccl.h +++ b/include/yaz/ccl.h @@ -43,13 +43,13 @@ */ /** \file ccl.h - \brief Header with public definitions about CCL. + \brief Header with public definitions for CCL. */ /* * CCL - header file * - * $Id: ccl.h,v 1.19 2004-10-03 22:34:07 adam Exp $ + * $Id: ccl.h,v 1.20 2004-10-15 00:18:59 adam Exp $ * * Old Europagate Log: * diff --git a/include/yaz/charneg.h b/include/yaz/charneg.h index 2212f0f..24d2154 100644 --- a/include/yaz/charneg.h +++ b/include/yaz/charneg.h @@ -1,5 +1,35 @@ /* - * $Id: charneg.h,v 1.3 2002-07-25 12:50:16 adam Exp $ + * Copyright (c) 2002-2004, Index Data. + * + * Permission to use, copy, modify, distribute, and sell this software and + * its documentation, in whole or in part, for any purpose, is hereby granted, + * provided that: + * + * 1. This copyright and permission notice appear in all copies of the + * software and its documentation. Notices of copyright or attribution + * which appear at the beginning of any file must remain unchanged. + * + * 2. The name of Index Data or the individual authors may not be used to + * endorse or promote products derived from this software without specific + * prior written permission. + * + * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND, + * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY + * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. + * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL, + * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR + * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF + * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE + * OF THIS SOFTWARE. + * + * $Id: charneg.h,v 1.4 2004-10-15 00:18:59 adam Exp $ + */ +/** + * \file charneg.h + * \brief Header for Z39.50 Charset negotiation utilities + * + * Helper functions for Character Set and Language Negotiation - 3 */ #ifndef CHARNEG_H #define CHARNEG_H diff --git a/include/yaz/comstack.h b/include/yaz/comstack.h index d49bc23..f1c647f 100644 --- a/include/yaz/comstack.h +++ b/include/yaz/comstack.h @@ -23,7 +23,12 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: comstack.h,v 1.16 2004-05-10 10:47:04 adam Exp $ + * $Id: comstack.h,v 1.17 2004-10-15 00:18:59 adam Exp $ + */ + +/** + * \file comstack.h + * \brief Header for COMSTACK */ #ifndef COMSTACK_H diff --git a/include/yaz/diagbib1.h b/include/yaz/diagbib1.h index 1a953dd..d798977 100644 --- a/include/yaz/diagbib1.h +++ b/include/yaz/diagbib1.h @@ -23,7 +23,12 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: diagbib1.h,v 1.3 2003-03-03 19:57:35 adam Exp $ + * $Id: diagbib1.h,v 1.4 2004-10-15 00:18:59 adam Exp $ + */ + +/** + * \file diagbib1.h + * \brief Declares diagbib1_str */ #ifndef DIAGBIB1_H diff --git a/include/yaz/log.h b/include/yaz/log.h index b17c4ae..25b31d0 100644 --- a/include/yaz/log.h +++ b/include/yaz/log.h @@ -23,7 +23,12 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: log.h,v 1.12 2003-10-09 15:51:36 adam Exp $ + * $Id: log.h,v 1.13 2004-10-15 00:18:59 adam Exp $ + */ + +/** + * \file log.h + * \brief Header for logging utility */ #ifndef LOG_H diff --git a/include/yaz/logrpn.h b/include/yaz/logrpn.h index 07af8ca..2a18227 100644 --- a/include/yaz/logrpn.h +++ b/include/yaz/logrpn.h @@ -1,8 +1,13 @@ /* - * Copyright (c) 1997-2003, Index Data. + * Copyright (c) 1997-2004, Index Data. * See the file LICENSE for details. * - * $Id: logrpn.h,v 1.4 2003-03-03 19:57:35 adam Exp $ + * $Id: logrpn.h,v 1.5 2004-10-15 00:18:59 adam Exp $ + */ + +/** + * \file logrpn.h + * \brief Header for Z39.50 Query Printing */ #ifndef LOG_RPN_H diff --git a/include/yaz/marcdisp.h b/include/yaz/marcdisp.h index 4632307..69c65be 100644 --- a/include/yaz/marcdisp.h +++ b/include/yaz/marcdisp.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-2003, Index Data. + * Copyright (c) 1995-2004, Index Data. * * Permission to use, copy, modify, distribute, and sell this software and * its documentation, in whole or in part, for any purpose, is hereby granted, @@ -23,7 +23,12 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: marcdisp.h,v 1.9 2003-12-11 00:37:21 adam Exp $ + * $Id: marcdisp.h,v 1.10 2004-10-15 00:18:59 adam Exp $ + */ + +/** + * \file marcdisp.h + * \brief Header for MARC display - and conversion utilities */ #ifndef MARCDISP_H diff --git a/include/yaz/nmem.h b/include/yaz/nmem.h index 293840c..07bf995 100644 --- a/include/yaz/nmem.h +++ b/include/yaz/nmem.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-2003, Index Data. + * Copyright (c) 1995-2004, Index Data. * * Permission to use, copy, modify, distribute, and sell this software and * its documentation, in whole or in part, for any purpose, is hereby granted, @@ -23,9 +23,16 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: nmem.h,v 1.12 2004-01-15 10:16:26 adam Exp $ + * $Id: nmem.h,v 1.13 2004-10-15 00:18:59 adam Exp $ */ +/** + * \file nmem.h + * \brief Header for Nibble Memory functions + * + * This is a simple and fairly wasteful little module for nibble memory + * allocation. Evemtually we'll put in something better. + */ #ifndef NMEM_H #define NMEM_H #include diff --git a/include/yaz/odr.h b/include/yaz/odr.h index 9c4f658..b093f96 100644 --- a/include/yaz/odr.h +++ b/include/yaz/odr.h @@ -23,7 +23,12 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: odr.h,v 1.16 2004-08-13 07:30:06 adam Exp $ + * $Id: odr.h,v 1.17 2004-10-15 00:18:59 adam Exp $ + */ + +/** + * \file odr.h + * \brief Header for ODR (Open Data Representation) */ #ifndef ODR_H diff --git a/include/yaz/oid.h b/include/yaz/oid.h index f47911f..ea921c9 100644 --- a/include/yaz/oid.h +++ b/include/yaz/oid.h @@ -23,9 +23,17 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: oid.h,v 1.21 2003-11-19 13:47:20 mike Exp $ + * $Id: oid.h,v 1.22 2004-10-15 00:18:59 adam Exp $ */ +/** + * \file oid.h + * \brief Header for OID database + * + * More or less protocol-transparent OID database. + * We could (and should?) extend this so that the user app can add new + * entries to the list at initialization. + */ #ifndef OID_H #define OID_H diff --git a/include/yaz/options.h b/include/yaz/options.h index 4ad5968..72cd9c1 100644 --- a/include/yaz/options.h +++ b/include/yaz/options.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-2003, Index Data. + * Copyright (c) 1995-2004, Index Data. * * Permission to use, copy, modify, distribute, and sell this software and * its documentation, in whole or in part, for any purpose, is hereby granted, @@ -23,7 +23,12 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: options.h,v 1.3 2003-03-03 19:57:35 adam Exp $ + * $Id: options.h,v 1.4 2004-10-15 00:18:59 adam Exp $ + */ + +/** + * \file options.h + * \brief Header for command line options parsing utilities */ #ifndef OPTIONS_H diff --git a/include/yaz/otherinfo.h b/include/yaz/otherinfo.h index 69dc8dd..ec57be3 100644 --- a/include/yaz/otherinfo.h +++ b/include/yaz/otherinfo.h @@ -1,9 +1,12 @@ /* - * Copyright (c) 1999, Index Data + * Copyright (c) 1999-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: otherinfo.h,v 1.2 2000-02-28 11:20:06 adam Exp $ + * $Id: otherinfo.h,v 1.3 2004-10-15 00:18:59 adam Exp $ + */ +/** + * \file otherinfo.h + * \brief Header for Z39.50 OtherInfo utilities */ #ifndef OTHERINFO_H #define OTHERINFO_H diff --git a/include/yaz/pquery.h b/include/yaz/pquery.h index bbb6975..9bc6d92 100644 --- a/include/yaz/pquery.h +++ b/include/yaz/pquery.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-2003, Index Data. + * Copyright (c) 1995-2004, Index Data. * * Permission to use, copy, modify, distribute, and sell this software and * its documentation, in whole or in part, for any purpose, is hereby granted, @@ -23,7 +23,11 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: pquery.h,v 1.4 2003-01-06 08:20:27 adam Exp $ + * $Id: pquery.h,v 1.5 2004-10-15 00:18:59 adam Exp $ + */ +/** + * \file pquery.h + * \brief Header for PQF parsing */ #ifndef PQUERY_H diff --git a/include/yaz/proto.h b/include/yaz/proto.h index c35dbe4..a92cf3f 100644 --- a/include/yaz/proto.h +++ b/include/yaz/proto.h @@ -2,7 +2,11 @@ * Copyright (c) 1998-2004, Index Data * See the file LICENSE for details. * - * $Id: proto.h,v 1.15 2004-05-10 07:52:07 adam Exp $ + * $Id: proto.h,v 1.16 2004-10-15 00:18:59 adam Exp $ + */ +/** + * \file proto.h + * \brief Header for Z39.50 Protocol */ #ifndef Z_PROTO_H #define Z_PROTO_H diff --git a/include/yaz/prt-ext.h b/include/yaz/prt-ext.h index 731acdb..05aa2d5 100644 --- a/include/yaz/prt-ext.h +++ b/include/yaz/prt-ext.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-2003, Index Data. + * Copyright (c) 1995-2004, Index Data. * * Permission to use, copy, modify, distribute, and sell this software and * its documentation, in whole or in part, for any purpose, is hereby granted, @@ -23,6 +23,12 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * + * $Id: prt-ext.h,v 1.10 2004-10-15 00:18:59 adam Exp $ + */ + +/** + * \file prt-ext.h + * \brief Header for Z39.50 External utilities */ /* @@ -38,11 +44,10 @@ YAZ_BEGIN_CDECL -/* +/** * Used to keep track of known External definitions (a loose approach * to DEFINED_BY). */ - typedef struct Z_ext_typeent { oid_value dref; /* the direct-reference OID value. */ diff --git a/include/yaz/readconf.h b/include/yaz/readconf.h index 27e0772..cba053b 100644 --- a/include/yaz/readconf.h +++ b/include/yaz/readconf.h @@ -1,3 +1,34 @@ +/* + * Copyright (c) 1996-2004, Index Data. + * + * Permission to use, copy, modify, distribute, and sell this software and + * its documentation, in whole or in part, for any purpose, is hereby granted, + * provided that: + * + * 1. This copyright and permission notice appear in all copies of the + * software and its documentation. Notices of copyright or attribution + * which appear at the beginning of any file must remain unchanged. + * + * 2. The names of Index Data or the individual authors may not be used to + * endorse or promote products derived from this software without specific + * prior written permission. + * + * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND, + * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY + * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. + * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL, + * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR + * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF + * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE + * OF THIS SOFTWARE. + * + * $Id: readconf.h,v 1.3 2004-10-15 00:18:59 adam Exp $ + */ +/** + * \file readconf.h + * \brief Header for config file reading utilities + */ #ifndef READCONF_H #define READCONF_H diff --git a/include/yaz/soap.h b/include/yaz/soap.h index 46f602d..d94a60a 100644 --- a/include/yaz/soap.h +++ b/include/yaz/soap.h @@ -2,7 +2,11 @@ * Copyright (c) 2002-2004, Index Data. * See the file LICENSE for details. * - * $Id: soap.h,v 1.7 2004-01-07 21:02:42 adam Exp $ + * $Id: soap.h,v 1.8 2004-10-15 00:18:59 adam Exp $ + */ +/** + * \file soap.h + * \brief Header for SOAP */ #ifndef YAZ_SOAP_H diff --git a/include/yaz/sortspec.h b/include/yaz/sortspec.h index 98a63e0..d765f78 100644 --- a/include/yaz/sortspec.h +++ b/include/yaz/sortspec.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-2001, Index Data. + * Copyright (c) 1995-2004, Index Data. * * Permission to use, copy, modify, distribute, and sell this software and * its documentation, in whole or in part, for any purpose, is hereby granted, @@ -23,9 +23,12 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: sortspec.h,v 1.1 2001-08-08 19:35:06 adam Exp $ + * $Id: sortspec.h,v 1.2 2004-10-15 00:18:59 adam Exp $ + */ +/** + * \file sortspec.h + * \brief Header for SortSpec parsing. */ - #ifndef SORTSPEC_H #define SORTSPEC_H diff --git a/include/yaz/srw.h b/include/yaz/srw.h index 8c93983..36f08b3 100644 --- a/include/yaz/srw.h +++ b/include/yaz/srw.h @@ -2,7 +2,11 @@ * Copyright (c) 2002-2004, Index Data. * See the file LICENSE for details. * - * $Id: srw.h,v 1.16 2004-02-14 15:58:42 adam Exp $ + * $Id: srw.h,v 1.17 2004-10-15 00:18:59 adam Exp $ + */ +/** + * \file srw.h + * \brief Header for SRW/SRU */ #ifndef YAZ_SRW_H diff --git a/include/yaz/statserv.h b/include/yaz/statserv.h index c8cf21e..c78073f 100644 --- a/include/yaz/statserv.h +++ b/include/yaz/statserv.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-2000, Index Data. + * Copyright (c) 1995-2004, Index Data. * * Permission to use, copy, modify, distribute, and sell this software and * its documentation, in whole or in part, for any purpose, is hereby granted, @@ -23,7 +23,12 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: statserv.h,v 1.6 2003-03-03 19:57:35 adam Exp $ + * $Id: statserv.h,v 1.7 2004-10-15 00:18:59 adam Exp $ + */ + +/** + * \file statserv.h + * \brief Header for GFS (Obsolete. Use yaz/backend.h) */ #ifndef STATSERVER_H diff --git a/include/yaz/tcpip.h b/include/yaz/tcpip.h index a9581db..591c526 100644 --- a/include/yaz/tcpip.h +++ b/include/yaz/tcpip.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-2003, Index Data. + * Copyright (c) 1995-2004, Index Data. * * Permission to use, copy, modify, distribute, and sell this software and * its documentation, in whole or in part, for any purpose, is hereby granted, @@ -23,7 +23,11 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: tcpip.h,v 1.4 2003-03-03 19:57:35 adam Exp $ + * $Id: tcpip.h,v 1.5 2004-10-15 00:18:59 adam Exp $ + */ +/** + * \file tcpip.h + * \brief Header for TCP/IP + SSL COMSTACK. */ #ifndef TCPIP_H diff --git a/include/yaz/tpath.h b/include/yaz/tpath.h index e6b240e..4ed39bf 100644 --- a/include/yaz/tpath.h +++ b/include/yaz/tpath.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-2003, Index Data. + * Copyright (c) 1995-2004, Index Data. * * Permission to use, copy, modify, distribute, and sell this software and * its documentation, in whole or in part, for any purpose, is hereby granted, @@ -23,9 +23,13 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: tpath.h,v 1.5 2003-01-06 08:20:27 adam Exp $ + * $Id: tpath.h,v 1.6 2004-10-15 00:18:59 adam Exp $ * */ +/** + * \file tpath.h + * \brief Header for path fopen + */ #ifndef TPATH_H #define TPATH_H diff --git a/include/yaz/unix.h b/include/yaz/unix.h index 7b7054b..e30aed5 100644 --- a/include/yaz/unix.h +++ b/include/yaz/unix.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-2003, Index Data. + * Copyright (c) 1995-2004, Index Data. * * Permission to use, copy, modify, distribute, and sell this software and * its documentation, in whole or in part, for any purpose, is hereby granted, @@ -23,9 +23,12 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: unix.h,v 1.2 2003-01-06 08:20:27 adam Exp $ + * $Id: unix.h,v 1.3 2004-10-15 00:18:59 adam Exp $ * UNIX socket COMSTACK. By Morten Bøgeskov. - * + */ +/** + * \file unix.h + * \brief Header for UNIX domain socket COMSTACK */ #ifndef UNIX_H diff --git a/include/yaz/wrbuf.h b/include/yaz/wrbuf.h index 05937a3..ab2acdc 100644 --- a/include/yaz/wrbuf.h +++ b/include/yaz/wrbuf.h @@ -23,8 +23,11 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: wrbuf.h,v 1.12 2004-03-20 07:02:22 adam Exp $ - * + * $Id: wrbuf.h,v 1.13 2004-10-15 00:18:59 adam Exp $ + */ +/** + * \file wrbuf.h + * \brief Header for WRBUF (growing buffer) */ #ifndef WRBUF_H diff --git a/include/yaz/xmalloc.h b/include/yaz/xmalloc.h index 2ba02bd..0aa8768 100644 --- a/include/yaz/xmalloc.h +++ b/include/yaz/xmalloc.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-2003, Index Data. + * Copyright (c) 1995-2004, Index Data. * * Permission to use, copy, modify, distribute, and sell this software and * its documentation, in whole or in part, for any purpose, is hereby granted, @@ -23,7 +23,11 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: xmalloc.h,v 1.3 2003-02-18 14:28:52 adam Exp $ + * $Id: xmalloc.h,v 1.4 2004-10-15 00:18:59 adam Exp $ + */ +/** + * \file xmalloc.h + * \brief Header for malloc interface. */ #ifndef XMALLOC_H diff --git a/include/yaz/xmosi.h b/include/yaz/xmosi.h deleted file mode 100644 index b41b113..0000000 --- a/include/yaz/xmosi.h +++ /dev/null @@ -1,85 +0,0 @@ -/* - * Copyright (c) 1995, Index Data. - * - * Permission to use, copy, modify, distribute, and sell this software and - * its documentation, in whole or in part, for any purpose, is hereby granted, - * provided that: - * - * 1. This copyright and permission notice appear in all copies of the - * software and its documentation. Notices of copyright or attribution - * which appear at the beginning of any file must remain unchanged. - * - * 2. The name of Index Data or the individual authors may not be used to - * endorse or promote products derived from this software without specific - * prior written permission. - * - * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND, - * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY - * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. - * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL, - * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR - * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF - * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE - * OF THIS SOFTWARE. - * - * $Log: xmosi.h,v $ - * Revision 1.1 1999-11-30 13:47:11 adam - * Improved installation. Moved header files to include/yaz. - * - * Revision 1.7 1999/06/16 11:55:24 adam - * Added APDU log to client. - * - * Revision 1.6 1997/05/14 06:53:53 adam - * C++ support. - * - * Revision 1.5 1996/02/10 12:23:43 quinn - * Enable inetd operations fro TCP/IP stack - * - * Revision 1.4 1995/09/29 17:12:13 quinn - * Smallish - * - * Revision 1.3 1995/09/27 15:02:53 quinn - * Modified function heads & prototypes. - * - * Revision 1.2 1995/05/16 08:50:39 quinn - * License, documentation, and memory fixes - * - * Revision 1.1 1995/03/30 09:39:43 quinn - * Moved .h files to include directory - * - * Revision 1.3 1995/03/27 08:36:16 quinn - * Some work on nonblocking operation in xmosi.c and rfct.c. - * Added protocol parameter to cs_create() - * - * Revision 1.2 1995/03/14 10:28:48 quinn - * Adding server-side support to tcpip.c and fixing bugs in nonblocking I/O - * - * Revision 1.1 1995/03/01 08:40:33 quinn - * First working version of rfct. Addressing needs work. - * - */ - -#ifndef XMOSI_H -#define XMOSI_H - -#include -#include -#include -#include -#include -#include - -#ifdef __cplusplus -extern "C" { -#endif - -struct netbuf *mosi_strtoaddr(const char *str); - -COMSTACK mosi_type(int s, int blocking, int protocol); - -#ifdef __cplusplus -} -#endif - -#endif diff --git a/include/yaz/yaz-ccl.h b/include/yaz/yaz-ccl.h index e92e041..aff6fd7 100644 --- a/include/yaz/yaz-ccl.h +++ b/include/yaz/yaz-ccl.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-2003, Index Data. + * Copyright (c) 1995-2004, Index Data. * * Permission to use, copy, modify, distribute, and sell this software and * its documentation, in whole or in part, for any purpose, is hereby granted, @@ -23,7 +23,11 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: yaz-ccl.h,v 1.6 2003-06-24 23:03:04 adam Exp $ + * $Id: yaz-ccl.h,v 1.7 2004-10-15 00:18:59 adam Exp $ + */ +/** + * \file yaz-ccl.h + * \brief Header for CCL node tree to RPN converson utilities. */ #ifndef YAZ_CCL_H diff --git a/include/yaz/yaz-iconv.h b/include/yaz/yaz-iconv.h index e6bf212..86cbf08 100644 --- a/include/yaz/yaz-iconv.h +++ b/include/yaz/yaz-iconv.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-2003, Index Data. + * Copyright (c) 1995-2004, Index Data. * * Permission to use, copy, modify, distribute, and sell this software and * its documentation, in whole or in part, for any purpose, is hereby granted, @@ -23,7 +23,11 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: yaz-iconv.h,v 1.4 2003-05-06 11:51:23 adam Exp $ + * $Id: yaz-iconv.h,v 1.5 2004-10-15 00:18:59 adam Exp $ + */ +/** + * \file yaz-iconv.h + * \brief Header for YAZ iconv interface */ #ifndef YAZ_ICONV_H diff --git a/include/yaz/yaz-util.h b/include/yaz/yaz-util.h index 2c47f44..b21fb88 100644 --- a/include/yaz/yaz-util.h +++ b/include/yaz/yaz-util.h @@ -1,9 +1,33 @@ /* - * Copyright (c) 1995-2003, Index Data. - * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss + * Copyright (c) 1995-2004, Index Data. * - * $Id: yaz-util.h,v 1.9 2003-02-18 14:28:52 adam Exp $ + * Permission to use, copy, modify, distribute, and sell this software and + * its documentation, in whole or in part, for any purpose, is hereby granted, + * provided that: + * + * 1. This copyright and permission notice appear in all copies of the + * software and its documentation. Notices of copyright or attribution + * which appear at the beginning of any file must remain unchanged. + * + * 2. The name of Index Data or the individual authors may not be used to + * endorse or promote products derived from this software without specific + * prior written permission. + * + * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND, + * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY + * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. + * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL, + * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR + * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF + * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE + * OF THIS SOFTWARE. + * + * $Id: yaz-util.h,v 1.10 2004-10-15 00:18:59 adam Exp $ + */ +/** + * \file yaz-util.h + * \brief Header for common YAZ utilities */ #ifndef YAZ_UTIL_H diff --git a/include/yaz/yconfig.h b/include/yaz/yconfig.h index 5c995b4..1b8d5a1 100644 --- a/include/yaz/yconfig.h +++ b/include/yaz/yconfig.h @@ -1,8 +1,33 @@ /* - * Copyright (c) 1995-2003, Index Data. - * See the file LICENSE for details. + * Copyright (c) 1995-2004, Index Data. * - * $Id: yconfig.h,v 1.6 2003-02-18 14:28:52 adam Exp $ + * Permission to use, copy, modify, distribute, and sell this software and + * its documentation, in whole or in part, for any purpose, is hereby granted, + * provided that: + * + * 1. This copyright and permission notice appear in all copies of the + * software and its documentation. Notices of copyright or attribution + * which appear at the beginning of any file must remain unchanged. + * + * 2. The name of Index Data or the individual authors may not be used to + * endorse or promote products derived from this software without specific + * prior written permission. + * + * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND, + * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY + * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. + * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL, + * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR + * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF + * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE + * OF THIS SOFTWARE. + * + * $Id: yconfig.h,v 1.7 2004-10-15 00:18:59 adam Exp $ + */ +/** + * \file yconfig.h + * \brief Header with fundamental macros */ #ifndef YCONFIG_H diff --git a/include/yaz/zgdu.h b/include/yaz/zgdu.h index e24a4ab..17ffa08 100644 --- a/include/yaz/zgdu.h +++ b/include/yaz/zgdu.h @@ -1,10 +1,15 @@ /* - * Copyright (c) 1998-2003, Index Data + * Copyright (c) 1998-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: zgdu.h,v 1.2 2003-12-04 11:46:36 adam Exp $ + * $Id: zgdu.h,v 1.3 2004-10-15 00:18:59 adam Exp $ */ + +/** + * \file zgdu.h + * \brief Header for the Z_GDU (HTTP or Z39.50 package) + */ + #ifndef Z_GDU_H #define Z_GDU_H diff --git a/include/yaz/zoom.h b/include/yaz/zoom.h index 199eeb0..d1037ea 100644 --- a/include/yaz/zoom.h +++ b/include/yaz/zoom.h @@ -1,6 +1,12 @@ /* - * Public header for ZOOM C. - * $Id: zoom.h,v 1.23 2004-04-28 22:44:59 adam Exp $ + * Copyright (c) 2000-2004, Index Data + * See the file LICENSE for details. + * + * $Id: zoom.h,v 1.24 2004-10-15 00:18:59 adam Exp $ + */ +/** + * \file zoom.h + * \brief Header for ZOOM */ #include diff --git a/src/atoin.c b/src/atoin.c index cb3a899..47f5cd8 100644 --- a/src/atoin.c +++ b/src/atoin.c @@ -2,7 +2,12 @@ * Copyright (c) 1997-2004, Index Data * See the file LICENSE for details. * - * $Id: atoin.c,v 1.2 2004-08-13 11:35:37 adam Exp $ + * $Id: atoin.c,v 1.3 2004-10-15 00:18:59 adam Exp $ + */ + +/** + * \file atoin.c + * \brief Implements atoi_n function. */ #if HAVE_CONFIG_H @@ -13,6 +18,9 @@ #include #include +/** + * atoi_n: like atoi but reads at most len characters. + */ int atoi_n (const char *buf, int len) { int val = 0; diff --git a/src/ber_any.c b/src/ber_any.c index c28ebb5..f21b416 100644 --- a/src/ber_any.c +++ b/src/ber_any.c @@ -1,9 +1,18 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: ber_any.c,v 1.1 2003-10-27 12:21:30 adam Exp $ + * $Id: ber_any.c,v 1.2 2004-10-15 00:18:59 adam Exp $ */ + +/** + * \file ber_any.c + * \brief Implements BER ANY encoding and decoding. + * + * This source file implements BER encoding and decoding of + * the ANY type. + */ + #if HAVE_CONFIG_H #include #endif diff --git a/src/ber_bit.c b/src/ber_bit.c index 38260f0..2d590f3 100644 --- a/src/ber_bit.c +++ b/src/ber_bit.c @@ -1,11 +1,18 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: ber_bit.c,v 1.1 2003-10-27 12:21:30 adam Exp $ + * $Id: ber_bit.c,v 1.2 2004-10-15 00:18:59 adam Exp $ + */ + +/** + * \file ber_bit.c + * \brief Implements BER BITSTRING encoding and decoding. * + * This source file implements BER encoding and decoding of + * the BITSTRING type. */ + #if HAVE_CONFIG_H #include #endif diff --git a/src/ber_bool.c b/src/ber_bool.c index 2e4cca3..b813ff1 100644 --- a/src/ber_bool.c +++ b/src/ber_bool.c @@ -1,9 +1,16 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: ber_bool.c,v 1.1 2003-10-27 12:21:30 adam Exp $ + * $Id: ber_bool.c,v 1.2 2004-10-15 00:18:59 adam Exp $ + */ + +/** + * \file ber_bool.c + * \brief Implements BER BOOLEAN encoding and decoding + * + * This source file implements BER encoding and decoding of + * the BOOLEAN type. */ #if HAVE_CONFIG_H diff --git a/src/ber_int.c b/src/ber_int.c index 7b1aba8..ef1a0e0 100644 --- a/src/ber_int.c +++ b/src/ber_int.c @@ -1,10 +1,18 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: ber_int.c,v 1.1 2003-10-27 12:21:30 adam Exp $ + * $Id: ber_int.c,v 1.2 2004-10-15 00:18:59 adam Exp $ */ + +/** + * \file ber_int.c + * \brief Implements BER INTEGER encoding and decoding. + * + * This source file implements BER encoding and decoding of + * the INTEGER type. + */ + #if HAVE_CONFIG_H #include #endif diff --git a/src/ber_len.c b/src/ber_len.c index bb4c08a..bc12463 100644 --- a/src/ber_len.c +++ b/src/ber_len.c @@ -1,10 +1,18 @@ /* - * Copyright (C) 1995-2003, Index Data. + * Copyright (C) 1995-2004, Index Data. * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: ber_len.c,v 1.1 2003-10-27 12:21:30 adam Exp $ + * $Id: ber_len.c,v 1.2 2004-10-15 00:18:59 adam Exp $ */ + +/** + * \file ber_len.c + * \brief Implements BER length octet encoding and decoding + * + * This source file implements BER encoding and decoding of + * the length octets. + */ + #if HAVE_CONFIG_H #include #endif @@ -12,7 +20,8 @@ #include #include "odr-priv.h" -/* +/** + * ber_enclen: * Encode BER length octets. If exact, lenlen is the exact desired * encoding size, else, lenlen is the max available space. Len < 0 = * Indefinite encoding. @@ -78,7 +87,8 @@ int ber_enclen(ODR o, int len, int lenlen, int exact) return odr_tell(o) - lenpos; } -/* +/** + * ber_declen: * Decode BER length octets. Returns * > 0 : number of bytes read * -1 : not enough room to read bytes within max bytes diff --git a/src/ber_null.c b/src/ber_null.c index b0db7f3..3e694b6 100644 --- a/src/ber_null.c +++ b/src/ber_null.c @@ -1,9 +1,16 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: ber_null.c,v 1.1 2003-10-27 12:21:30 adam Exp $ + * $Id: ber_null.c,v 1.2 2004-10-15 00:18:59 adam Exp $ + */ + +/** + * \file ber_null.c + * \brief Implements ber_null + * + * This source file implements BER encoding and decoding of + * the NULL type. */ #if HAVE_CONFIG_H #include @@ -11,8 +18,8 @@ #include "odr-priv.h" -/* - * BER-en/decoder for NULL type. +/** + * ber_null: BER-en/decoder for NULL type. */ int ber_null(ODR o) { @@ -40,7 +47,10 @@ int ber_null(ODR o) fprintf(stderr, "[NULL]\n"); #endif return 1; - case ODR_PRINT: return 1; - default: odr_seterror(o, OOTHER, 13); return 0; + case ODR_PRINT: + return 1; + default: + odr_seterror(o, OOTHER, 13); + return 0; } } diff --git a/src/ber_oct.c b/src/ber_oct.c index 133a64b..ad19db5 100644 --- a/src/ber_oct.c +++ b/src/ber_oct.c @@ -1,10 +1,18 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: ber_oct.c,v 1.1 2003-10-27 12:21:30 adam Exp $ + * $Id: ber_oct.c,v 1.2 2004-10-15 00:18:59 adam Exp $ */ + +/** + * \file ber_oct.c + * \brief Implements ber_octetstring + * + * This source file implements BER encoding and decoding of + * the OCTETSTRING type. + */ + #if HAVE_CONFIG_H #include #endif @@ -19,57 +27,60 @@ int ber_octetstring(ODR o, Odr_oct *p, int cons) switch (o->direction) { - case ODR_DECODE: - if ((res = ber_declen(o->bp, &len, odr_max(o))) < 0) - { - odr_seterror(o, OPROTO, 14); - return 0; - } - o->bp += res; - if (cons) /* fetch component strings */ - { - base = o->bp; - while (odp_more_chunks(o, base, len)) - if (!odr_octetstring(o, &p, 0, 0)) - return 0; - return 1; - } - /* primitive octetstring */ - if (len < 0) - { - odr_seterror(o, OOTHER, 15); - return 0; - } - if (len > odr_max(o)) - { - odr_seterror(o, OOTHER, 16); - return 0; - } - if (len + 1 > p->size - p->len) - { - c = (unsigned char *)odr_malloc(o, p->size += len + 1); - if (p->len) - memcpy(c, p->buf, p->len); - p->buf = c; - } - if (len) - memcpy(p->buf + p->len, o->bp, len); - p->len += len; - o->bp += len; - /* the final null is really not part of the buffer, but */ - /* it helps somes applications that assumes C strings */ - if (len) - p->buf[p->len] = '\0'; + case ODR_DECODE: + if ((res = ber_declen(o->bp, &len, odr_max(o))) < 0) + { + odr_seterror(o, OPROTO, 14); + return 0; + } + o->bp += res; + if (cons) /* fetch component strings */ + { + base = o->bp; + while (odp_more_chunks(o, base, len)) + if (!odr_octetstring(o, &p, 0, 0)) + return 0; return 1; - case ODR_ENCODE: - if ((res = ber_enclen(o, p->len, 5, 0)) < 0) - return 0; - if (p->len == 0) - return 1; - if (odr_write(o, p->buf, p->len) < 0) - return 0; + } + /* primitive octetstring */ + if (len < 0) + { + odr_seterror(o, OOTHER, 15); + return 0; + } + if (len > odr_max(o)) + { + odr_seterror(o, OOTHER, 16); + return 0; + } + if (len + 1 > p->size - p->len) + { + c = (unsigned char *)odr_malloc(o, p->size += len + 1); + if (p->len) + memcpy(c, p->buf, p->len); + p->buf = c; + } + if (len) + memcpy(p->buf + p->len, o->bp, len); + p->len += len; + o->bp += len; + /* the final null is really not part of the buffer, but */ + /* it helps somes applications that assumes C strings */ + if (len) + p->buf[p->len] = '\0'; + return 1; + case ODR_ENCODE: + if ((res = ber_enclen(o, p->len, 5, 0)) < 0) + return 0; + if (p->len == 0) return 1; - case ODR_PRINT: return 1; - default: odr_seterror(o, OOTHER, 17); return 0; + if (odr_write(o, p->buf, p->len) < 0) + return 0; + return 1; + case ODR_PRINT: + return 1; + default: + odr_seterror(o, OOTHER, 17); + return 0; } } diff --git a/src/ber_oid.c b/src/ber_oid.c index fa983bd..eba9ce6 100644 --- a/src/ber_oid.c +++ b/src/ber_oid.c @@ -2,7 +2,15 @@ * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: ber_oid.c,v 1.3 2004-02-16 17:57:05 adam Exp $ + * $Id: ber_oid.c,v 1.4 2004-10-15 00:18:59 adam Exp $ + */ + +/** + * \file ber_oid.c + * \brief Implements BER OID encoding and decoding + * + * This source file implements BER encoding and decoding of + * the OID type. */ #if HAVE_CONFIG_H #include diff --git a/src/ber_tag.c b/src/ber_tag.c index 8149f42..9e4d31e 100644 --- a/src/ber_tag.c +++ b/src/ber_tag.c @@ -2,7 +2,15 @@ * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: ber_tag.c,v 1.2 2004-04-14 12:58:27 adam Exp $ + * $Id: ber_tag.c,v 1.3 2004-10-15 00:18:59 adam Exp $ + */ + +/** + * \file ber_tag.c + * \brief Implements BER tags encoding and decoding + * + * This source file implements BER encoding and decoding of + * the tags. */ #if HAVE_CONFIG_H #include diff --git a/src/cclerrms.c b/src/cclerrms.c index 53d4ac5..2c4256b 100644 --- a/src/cclerrms.c +++ b/src/cclerrms.c @@ -41,10 +41,20 @@ * USE OR PERFORMANCE OF THIS SOFTWARE. * */ + +/** + * \file cclerrms.c + * \brief Implements CCL error code to error string map. + * + * This source file implements mapping between CCL error code and + * their string equivalents. + */ + + /* * Europagate, 1995 * - * $Id: cclerrms.c,v 1.1 2003-10-27 12:21:30 adam Exp $ + * $Id: cclerrms.c,v 1.2 2004-10-15 00:18:59 adam Exp $ * * Old Europagate Log: * diff --git a/src/cclfind.c b/src/cclfind.c index bef1d81..6db1d84 100644 --- a/src/cclfind.c +++ b/src/cclfind.c @@ -41,10 +41,22 @@ * USE OR PERFORMANCE OF THIS SOFTWARE. * */ + +/** + * \file cclfind.c + * \brief Implements parsing of a CCL FIND query. + * + * This source file implements parsing of a CCL Query (ISO8777). + * The parser uses predictive parsing, but it does several tokens + * of lookahead in the handling of relational operations.. So + * it's not really pure. + */ + + /* CCL find (to rpn conversion) * Europagate, 1995 * - * $Id: cclfind.c,v 1.5 2004-10-10 21:43:21 adam Exp $ + * $Id: cclfind.c,v 1.6 2004-10-15 00:18:59 adam Exp $ * * Old Europagate log: * @@ -109,7 +121,7 @@ /* move one token forward */ #define ADVANCE cclp->look_token = cclp->look_token->next -/* +/** * qual_val_type: test for existance of attribute type/value pair. * qa: Attribute array * type: Type of attribute to search for @@ -139,7 +151,7 @@ static int qual_val_type (struct ccl_rpn_attr **qa, int type, int value, return 0; } -/* +/** * strxcat: concatenate strings. * n: Null-terminated Destination string * src: Source string to be appended (not null-terminated) @@ -154,7 +166,7 @@ static void strxcat (char *n, const char *src, int len) *n = '\0'; } -/* +/** * copy_token_name: Return copy of CCL token name * tp: Pointer to token info. * return: malloc(3) allocated copy of token name. @@ -168,7 +180,7 @@ static char *copy_token_name (struct ccl_token *tp) return str; } -/* +/** * mk_node: Create RPN node. * kind: Type of node. * return: pointer to allocated node. @@ -182,7 +194,7 @@ static struct ccl_rpn_node *mk_node (int kind) return p; } -/* +/** * ccl_rpn_delete: Delete RPN tree. * rpn: Pointer to tree. */ @@ -260,7 +272,7 @@ static struct ccl_rpn_attr *add_attr_node (struct ccl_rpn_node *p, return n; } -/* +/** * add_attr_numeric: Add attribute (type/value) to RPN term node. * p: RPN node of type term. * type: Type of attribute @@ -288,7 +300,7 @@ static void add_attr_string (struct ccl_rpn_node *p, const char *set, } -/* +/** * search_term: Parse CCL search term. * cclp: CCL Parser * qa: Qualifier attributes already applied. @@ -740,7 +752,7 @@ struct ccl_rpn_node *qualifiers2 (CCL_parser cclp, struct ccl_rpn_attr **ap) return p; } -/* +/** * qualifiers1: Parse CCL qualifiers and search terms. * cclp: CCL Parser * la: Token pointer to RELATION token. @@ -892,7 +904,7 @@ static struct ccl_rpn_node *qualifiers1 (CCL_parser cclp, struct ccl_token *la, } -/* +/** * search_terms: Parse CCL search terms - including proximity. * cclp: CCL Parser * qa: Qualifier attributes already applied. @@ -954,7 +966,7 @@ static struct ccl_rpn_node *search_terms (CCL_parser cclp, return p1; } -/* +/** * search_elements: Parse CCL search elements * cclp: CCL Parser * qa: Qualifier attributes already applied. @@ -1048,7 +1060,7 @@ static struct ccl_rpn_node *search_elements (CCL_parser cclp, } } -/* +/** * find_spec: Parse CCL find specification * cclp: CCL Parser * qa: Qualifier attributes already applied. @@ -1135,7 +1147,7 @@ struct ccl_rpn_node *ccl_parser_find (CCL_parser cclp, struct ccl_token *list) return p; } -/* +/** * ccl_find: Parse CCL find - token representation * bibset: Bibset to be used for the parsing * list: List of tokens @@ -1161,7 +1173,7 @@ struct ccl_rpn_node *ccl_find (CCL_bibset bibset, struct ccl_token *list, return p; } -/* +/** * ccl_find_str: Parse CCL find - string representation * bibset: Bibset to be used for the parsing * str: String to be parsed diff --git a/src/cclptree.c b/src/cclptree.c index 7bbb0f2..920184a 100644 --- a/src/cclptree.c +++ b/src/cclptree.c @@ -41,10 +41,19 @@ * USE OR PERFORMANCE OF THIS SOFTWARE. * */ + +/** + * \file cclptree.c + * \brief Implements CCL parse tree printing + * + * This source file implements functions to parse and print + * a CCL node tree (as a result of parsing). + */ + /* CCL print rpn tree - infix notation * Europagate, 1995 * - * $Id: cclptree.c,v 1.2 2003-12-18 13:08:48 adam Exp $ + * $Id: cclptree.c,v 1.3 2004-10-15 00:18:59 adam Exp $ * * Old Europagate Log: * @@ -265,7 +274,7 @@ void ccl_pquery (WRBUF w, struct ccl_rpn_node *p) /* * Local variables: - * tab-width: 4 + * tab-width: 8 * c-basic-offset: 4 * End: */ diff --git a/src/cclqfile.c b/src/cclqfile.c index 1c53725..0684dc3 100644 --- a/src/cclqfile.c +++ b/src/cclqfile.c @@ -41,10 +41,14 @@ * USE OR PERFORMANCE OF THIS SOFTWARE. * */ +/** + * \file cclqfile.c + * \brief Implements parsing of CCL qualifier specs in files + */ /* CCL qualifiers * Europagate, 1995 * - * $Id: cclqfile.c,v 1.5 2004-10-02 13:28:26 adam Exp $ + * $Id: cclqfile.c,v 1.6 2004-10-15 00:19:00 adam Exp $ * * Old Europagate Log: * diff --git a/src/cclqual.c b/src/cclqual.c index b68f70d..62c078f 100644 --- a/src/cclqual.c +++ b/src/cclqual.c @@ -41,10 +41,14 @@ * USE OR PERFORMANCE OF THIS SOFTWARE. * */ +/** + * \file cclqual.c + * \brief Implements CCL qualifier utilities + */ /* CCL qualifiers * Europagate, 1995 * - * $Id: cclqual.c,v 1.1 2003-10-27 12:21:30 adam Exp $ + * $Id: cclqual.c,v 1.2 2004-10-15 00:19:00 adam Exp $ * * Old Europagate Log: * @@ -84,14 +88,14 @@ #include -/* Definition of CCL_bibset pointer */ +/** Definition of CCL_bibset pointer */ struct ccl_qualifiers { struct ccl_qualifier *list; struct ccl_qualifier_special *special; }; -/* CCL Qualifier special */ +/** CCL Qualifier special */ struct ccl_qualifier_special { char *name; char *value; @@ -184,7 +188,7 @@ void ccl_qual_add_combi (CCL_bibset b, const char *n, const char *names) } } -/* +/** * ccl_qual_add: Add qualifier to Bibset. If qualifier already * exists, then attributes are appendend to old * definition. @@ -254,7 +258,7 @@ void ccl_qual_add_set (CCL_bibset b, const char *name, int no, *attrp = NULL; } -/* +/** * ccl_qual_mk: Make new (empty) bibset. * return: empty bibset. */ @@ -267,7 +271,7 @@ CCL_bibset ccl_qual_mk (void) return b; } -/* +/** * ccl_qual_rm: Delete bibset. * b: pointer to bibset */ @@ -308,7 +312,7 @@ void ccl_qual_rm (CCL_bibset *b) *b = NULL; } -/* +/** * ccl_qual_search: Search for qualifier in bibset. * b: Bibset * name: Name of qualifier to search for (need no null-termination) diff --git a/src/cclstr.c b/src/cclstr.c index d7d76f9..bb38098 100644 --- a/src/cclstr.c +++ b/src/cclstr.c @@ -41,10 +41,14 @@ * USE OR PERFORMANCE OF THIS SOFTWARE. * */ +/** + * \file cclstr.c + * \brief Implements CCL string compare utilities + */ /* CCL string compare utilities * Europagate, 1995 * - * $Id: cclstr.c,v 1.1 2003-10-27 12:21:30 adam Exp $ + * $Id: cclstr.c,v 1.2 2004-10-15 00:19:00 adam Exp $ * * Old Europagate Log: * diff --git a/src/ccltoken.c b/src/ccltoken.c index 11273b3..7584473 100644 --- a/src/ccltoken.c +++ b/src/ccltoken.c @@ -41,10 +41,14 @@ * USE OR PERFORMANCE OF THIS SOFTWARE. * */ +/** + * \file ccltoken.c + * \brief Implements CCL lexical analyzer (scanner) + */ /* CCL - lexical analysis * Europagate, 1995 * - * $Id: ccltoken.c,v 1.4 2004-10-02 13:28:26 adam Exp $ + * $Id: ccltoken.c,v 1.5 2004-10-15 00:19:00 adam Exp $ * * Old Europagate Log: * diff --git a/src/charneg.c b/src/charneg.c index ebd10fc..302e098 100644 --- a/src/charneg.c +++ b/src/charneg.c @@ -1,8 +1,16 @@ -/* - $ $Id: charneg.c,v 1.1 2003-10-27 12:21:30 adam Exp $ - * Helper functions for Character Set and Language Negotiation - 3 +/* + * Copyright (c) 2002-2004, Index Data + * See the file LICENSE for details. + * + * $Id: charneg.c,v 1.2 2004-10-15 00:19:00 adam Exp $ */ +/** + * \file charneg.c + * \brief Implements Z39.50 Charset negotiation utilities + * + * Helper functions for Character Set and Language Negotiation - 3 + */ #include #include #include diff --git a/src/comstack.c b/src/comstack.c index 1d877ed..c943c46 100644 --- a/src/comstack.c +++ b/src/comstack.c @@ -2,7 +2,12 @@ * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: comstack.c,v 1.12 2004-09-30 10:00:17 adam Exp $ + * $Id: comstack.c,v 1.13 2004-10-15 00:19:00 adam Exp $ + */ + +/** + * \file comstack.c + * \brief Implements Generic COMSTACK functions */ #include diff --git a/src/cql.y b/src/cql.y index d2cc5c5..1206f21 100644 --- a/src/cql.y +++ b/src/cql.y @@ -1,4 +1,4 @@ -/* $Id: cql.y,v 1.6 2004-10-03 22:34:07 adam Exp $ +/* $Id: cql.y,v 1.7 2004-10-15 00:19:00 adam Exp $ Copyright (C) 2002-2004 Index Data Aps @@ -14,6 +14,7 @@ See the file LICENSE. * \brief Implements CQL parser. * * This is a YACC parser, but since it must be reentrant, Bison is required. + * The original source file is cql.y. */ #include #include @@ -22,12 +23,18 @@ See the file LICENSE. #include #include #include - + + /** Node in the LALR parse tree. */ typedef struct { + /** Inhereted attribute: relation */ struct cql_node *rel; + /** Synthesized attribute: CQL node */ struct cql_node *cql; + /** string buffer with token */ char *buf; + /** length of token */ size_t len; + /** size of buffer (len <= size) */ size_t size; } token; @@ -185,8 +192,10 @@ int yyerror(char *s) return 0; } -/* - * bison lexer for CQL. +/** + * putb is a utility that puts one character to the string + * in current lexical token. This routine deallocates as + * necessary using NMEM. */ static void putb(YYSTYPE *lval, CQL_parser cp, int c) @@ -204,6 +213,10 @@ static void putb(YYSTYPE *lval, CQL_parser cp, int c) } +/** + * yylex returns next token for Bison to be read. In this + * case one of the CQL terminals are returned. + */ int yylex(YYSTYPE *lval, void *vp) { CQL_parser cp = (CQL_parser) vp; diff --git a/src/cqlstring.c b/src/cqlstring.c index 94ea25e..40824c5 100644 --- a/src/cqlstring.c +++ b/src/cqlstring.c @@ -1,4 +1,4 @@ -/* $Id: cqlstring.c,v 1.2 2004-10-03 22:34:07 adam Exp $ +/* $Id: cqlstring.c,v 1.3 2004-10-15 00:19:00 adam Exp $ Copyright (C) 2002-2004 Index Data Aps @@ -12,7 +12,6 @@ See the file LICENSE for details. * \brief Implements query stream reader that reads from a C string. */ - #include struct cql_buf_info { @@ -20,7 +19,7 @@ struct cql_buf_info { int off; }; -int getbuf(void *vp) +static int getbuf(void *vp) { struct cql_buf_info *bi = (struct cql_buf_info *) vp; if (bi->str[bi->off] == 0) @@ -28,7 +27,7 @@ int getbuf(void *vp) return bi->str[bi->off++]; } -void ungetbuf(int b, void *vp) +static void ungetbuf(int b, void *vp) { struct cql_buf_info *bi = (struct cql_buf_info *) vp; if (b) diff --git a/src/diagbib1.c b/src/diagbib1.c index 0842c41..003f0c0 100644 --- a/src/diagbib1.c +++ b/src/diagbib1.c @@ -1,9 +1,13 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: diagbib1.c,v 1.1 2003-10-27 12:21:30 adam Exp $ + * $Id: diagbib1.c,v 1.2 2004-10-15 00:19:00 adam Exp $ + */ + +/** + * \file diagbib1.c + * \brief Implements diagbib1_str */ #include diff --git a/src/dumpber.c b/src/dumpber.c index 86c66e8..22a51e1 100644 --- a/src/dumpber.c +++ b/src/dumpber.c @@ -1,10 +1,15 @@ /* - * Copyright (c) 1995-2003, Index Data. + * Copyright (c) 1995-2004, Index Data. * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: dumpber.c,v 1.1 2003-10-27 12:21:30 adam Exp $ + * $Id: dumpber.c,v 1.2 2004-10-15 00:19:00 adam Exp $ */ + +/** + * \file dumpber.c + * \brief Implements BER dumping + */ + #if HAVE_CONFIG_H #include #endif diff --git a/src/eventl.c b/src/eventl.c index ac56264..6fa5b98 100644 --- a/src/eventl.c +++ b/src/eventl.c @@ -1,9 +1,16 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: eventl.c,v 1.1 2003-10-27 12:21:30 adam Exp $ + * $Id: eventl.c,v 1.2 2004-10-15 00:19:00 adam Exp $ + */ + +/** + * \file eventl.c + * \brief Implements event loop handling for GFS. + * + * This source implements the main event loop for the Generic Frontend + * Server. It uses select(2). */ #include diff --git a/src/eventl.h b/src/eventl.h index 43df1bc..553ece1 100644 --- a/src/eventl.h +++ b/src/eventl.h @@ -1,9 +1,16 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: eventl.h,v 1.1 2003-10-27 12:21:30 adam Exp $ + * $Id: eventl.h,v 1.2 2004-10-15 00:19:00 adam Exp $ + */ + +/** + * \file eventl.h + * \brief Definitions for event loop handling for GFS. + * + * This "private" header defines various functions for the + * main event loop in GFS. */ #ifndef EVENTL_H diff --git a/src/grs1disp.c b/src/grs1disp.c index bef6b3d..a5fa2fc 100644 --- a/src/grs1disp.c +++ b/src/grs1disp.c @@ -1,8 +1,13 @@ /* - * Copyright (c) 2002, Index Data. + * Copyright (c) 2002-2004, Index Data. * See the file LICENSE for details. * - * $Id: grs1disp.c,v 1.1 2003-10-27 12:21:30 adam Exp $ + * $Id: grs1disp.c,v 1.2 2004-10-15 00:19:00 adam Exp $ + */ + +/** + * \file grs1disp.c + * \brief Implements display of GRS-1 records */ #include diff --git a/src/ill-get.c b/src/ill-get.c index 86ea32d..7c6bbd4 100644 --- a/src/ill-get.c +++ b/src/ill-get.c @@ -1,40 +1,13 @@ /* - * Copyright (c) 1999-2001, Index Data. + * Copyright (c) 1999-2004, Index Data. * See the file LICENSE for details. * - * $Log: ill-get.c,v $ - * Revision 1.1 2003-10-27 12:21:30 adam - * Source restructure. yaz-marcdump part of installation - * - * Revision 1.9 2001/03/25 21:55:12 adam - * Added odr_intdup. Ztest server returns TaskPackage for ItemUpdate. - * - * Revision 1.8 2001/02/21 13:46:53 adam - * C++ fixes. - * - * Revision 1.7 2001/02/20 11:25:32 adam - * Added ill_get_APDU and ill_get_Cancel. - * - * Revision 1.6 2000/08/10 08:41:26 adam - * Fixes for ILL. - * - * Revision 1.5 2000/02/24 08:52:01 adam - * Bug fix. - * - * Revision 1.4 2000/02/04 11:01:15 adam - * Added more elements. - * - * Revision 1.3 2000/01/31 13:15:21 adam - * Removed uses of assert(3). Cleanup of ODR. CCL parser update so - * that some characters are not surrounded by spaces in resulting term. - * ILL-code updates. - * - * Revision 1.2 2000/01/15 09:38:51 adam - * Implemented ill_get_ILLRequest. Added some type mappings for ILL protocol. - * - * Revision 1.1 1999/12/16 23:36:19 adam - * Implemented ILL protocol. Minor updates ASN.1 compiler. - * + * $Id: ill-get.c,v 1.2 2004-10-15 00:19:00 adam Exp $ + */ + +/** + * \file ill-get.c + * \brief Implements ILL package creator utilities */ #include diff --git a/src/initopt.c b/src/initopt.c index d475a82..148880a 100644 --- a/src/initopt.c +++ b/src/initopt.c @@ -2,7 +2,12 @@ * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: initopt.c,v 1.2 2004-01-15 10:16:27 adam Exp $ + * $Id: initopt.c,v 1.3 2004-10-15 00:19:00 adam Exp $ + */ + +/** + * \file initopt.c + * \brief Implements Z39.50 Init Options Utility */ #if HAVE_CONFIG_H diff --git a/src/log.c b/src/log.c index 6d629bf..32e26d9 100644 --- a/src/log.c +++ b/src/log.c @@ -1,8 +1,13 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: log.c,v 1.1 2003-10-27 12:21:30 adam Exp $ + * $Id: log.c,v 1.2 2004-10-15 00:19:00 adam Exp $ + */ + +/** + * \file log.c + * \brief Implements logging utility */ #if HAVE_CONFIG_H diff --git a/src/logrpn.c b/src/logrpn.c index c2e9dd9..a396706 100644 --- a/src/logrpn.c +++ b/src/logrpn.c @@ -1,9 +1,15 @@ /* - * Copyright (C) 1995-2003, Index Data + * Copyright (C) 1995-2004, Index Data * All rights reserved. * - * $Id: logrpn.c,v 1.2 2004-09-13 09:23:33 adam Exp $ + * $Id: logrpn.c,v 1.3 2004-10-15 00:19:00 adam Exp $ */ + +/** + * \file logrpn.c + * \brief Implements Z39.50 Query Printing + */ + #include #include diff --git a/src/marcdisp.c b/src/marcdisp.c index 171e5a3..2e3f96a 100644 --- a/src/marcdisp.c +++ b/src/marcdisp.c @@ -2,7 +2,12 @@ * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: marcdisp.c,v 1.7 2004-10-01 11:45:48 adam Exp $ + * $Id: marcdisp.c,v 1.8 2004-10-15 00:19:00 adam Exp $ + */ + +/** + * \file marcdisp.c + * \brief Implements MARC display - and conversion utilities */ #if HAVE_CONFIG_H diff --git a/src/matchstr.c b/src/matchstr.c index 2ec92d8..95c32e0 100644 --- a/src/matchstr.c +++ b/src/matchstr.c @@ -1,10 +1,15 @@ /* - * Copyright (c) 1995-2003, Index Data. + * Copyright (c) 1995-2004, Index Data. * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: matchstr.c,v 1.1 2003-10-27 12:21:31 adam Exp $ + * $Id: matchstr.c,v 1.2 2004-10-15 00:19:00 adam Exp $ */ + +/** + * \file matchstr.c + * \brief Implements loose string matching + */ + #if HAVE_CONFIG_H #include #endif diff --git a/src/nmem.c b/src/nmem.c index 35426da..9738a6f 100644 --- a/src/nmem.c +++ b/src/nmem.c @@ -1,12 +1,14 @@ /* - * Copyright (c) 1995-2003, Index Data. + * Copyright (c) 1995-2004, Index Data. * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: nmem.c,v 1.3 2004-01-15 10:16:27 adam Exp $ + * $Id: nmem.c,v 1.4 2004-10-15 00:19:00 adam Exp $ */ -/* +/** + * \file nmem.c + * \brief Implements Nibble Memory + * * This is a simple and fairly wasteful little module for nibble memory * allocation. Evemtually we'll put in something better. */ diff --git a/src/nmemsdup.c b/src/nmemsdup.c index 69343f4..26d1b2f 100644 --- a/src/nmemsdup.c +++ b/src/nmemsdup.c @@ -1,9 +1,15 @@ /* - * Copyright (c) 1997-2003, Index Data. + * Copyright (c) 1997-2004, Index Data. * See the file LICENSE for details. * - * $Id: nmemsdup.c,v 1.1 2003-10-27 12:21:33 adam Exp $ + * $Id: nmemsdup.c,v 1.2 2004-10-15 00:19:00 adam Exp $ */ + +/** + * \file nmemsdup.c + * \brief Implements NMEM dup utilities + */ + #if HAVE_CONFIG_H #include #endif diff --git a/src/odr-priv.h b/src/odr-priv.h index 0d22c09..e42007f 100644 --- a/src/odr-priv.h +++ b/src/odr-priv.h @@ -23,7 +23,12 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: odr-priv.h,v 1.3 2004-08-13 07:30:06 adam Exp $ + * $Id: odr-priv.h,v 1.4 2004-10-15 00:19:00 adam Exp $ + */ + +/** + * \file odr-priv.h + * \brief Internal ODR definitions */ #ifndef ODR_PRIV_H diff --git a/src/odr.c b/src/odr.c index ea7a7f3..1e31f29 100644 --- a/src/odr.c +++ b/src/odr.c @@ -2,9 +2,15 @@ * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: odr.c,v 1.7 2004-10-02 13:28:26 adam Exp $ + * $Id: odr.c,v 1.8 2004-10-15 00:19:00 adam Exp $ * */ + +/** + * \file odr.c + * \brief Implements fundamental ODR functionality + */ + #if HAVE_CONFIG_H #include #endif diff --git a/src/odr_any.c b/src/odr_any.c index 78d77ae..5dfaab6 100644 --- a/src/odr_any.c +++ b/src/odr_any.c @@ -1,17 +1,22 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: odr_any.c,v 1.2 2004-08-11 12:15:38 adam Exp $ + * $Id: odr_any.c,v 1.3 2004-10-15 00:19:00 adam Exp $ */ + +/** + * \file odr_any.c + * \brief Implements ODR ANY codec + */ + #if HAVE_CONFIG_H #include #endif #include "odr-priv.h" -/* +/** * This is a catch-all type. It stuffs a random ostring (assumed to be properly * encoded) into the stream, or reads a full data element. Implicit tagging * does not work, and neither does the optional flag, unless the element diff --git a/src/odr_bit.c b/src/odr_bit.c index 11a1d2e..ab8d052 100644 --- a/src/odr_bit.c +++ b/src/odr_bit.c @@ -1,10 +1,15 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: odr_bit.c,v 1.2 2004-08-11 12:15:38 adam Exp $ + * $Id: odr_bit.c,v 1.3 2004-10-15 00:19:00 adam Exp $ */ + +/** + * \file odr_bit.c + * \brief Implements ODR BITSTRING codec + */ + #if HAVE_CONFIG_H #include #endif diff --git a/src/odr_bool.c b/src/odr_bool.c index 151d050..7106ac0 100644 --- a/src/odr_bool.c +++ b/src/odr_bool.c @@ -1,9 +1,13 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: odr_bool.c,v 1.2 2004-08-11 12:15:38 adam Exp $ + * $Id: odr_bool.c,v 1.3 2004-10-15 00:19:00 adam Exp $ + */ + +/** + * \file odr_bool.c + * \brief Implements ODR BOOLEAN codec */ #if HAVE_CONFIG_H #include diff --git a/src/odr_choice.c b/src/odr_choice.c index bc31ddf..3e8135f 100644 --- a/src/odr_choice.c +++ b/src/odr_choice.c @@ -1,10 +1,15 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: odr_choice.c,v 1.2 2004-08-11 12:15:38 adam Exp $ + * $Id: odr_choice.c,v 1.3 2004-10-15 00:19:00 adam Exp $ */ + +/** + * \file odr_choice.c + * \brief Implements ODR CHOICE codec + */ + #if HAVE_CONFIG_H #include #endif diff --git a/src/odr_cons.c b/src/odr_cons.c index 9740221..dce204d 100644 --- a/src/odr_cons.c +++ b/src/odr_cons.c @@ -2,9 +2,15 @@ * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: odr_cons.c,v 1.3 2004-08-13 07:30:06 adam Exp $ + * $Id: odr_cons.c,v 1.4 2004-10-15 00:19:00 adam Exp $ * */ + +/** + * \file odr_cons.c + * \brief Implements ODR constructed codec. + */ + #if HAVE_CONFIG_H #include #endif diff --git a/src/odr_enum.c b/src/odr_enum.c index 76aadd0..01dcfe0 100644 --- a/src/odr_enum.c +++ b/src/odr_enum.c @@ -1,9 +1,12 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: odr_enum.c,v 1.2 2004-08-11 12:15:38 adam Exp $ + * $Id: odr_enum.c,v 1.3 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file odr_enum.c + * \brief Implements ODR ENUM codec */ #if HAVE_CONFIG_H #include diff --git a/src/odr_int.c b/src/odr_int.c index 9e21a25..9381481 100644 --- a/src/odr_int.c +++ b/src/odr_int.c @@ -1,9 +1,12 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: odr_int.c,v 1.2 2004-08-11 12:15:38 adam Exp $ + * $Id: odr_int.c,v 1.3 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file odr_int.c + * \brief Implements ODR INTEGER codec */ #if HAVE_CONFIG_H #include diff --git a/src/odr_mem.c b/src/odr_mem.c index db9deca..5bd1289 100644 --- a/src/odr_mem.c +++ b/src/odr_mem.c @@ -2,7 +2,11 @@ * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: odr_mem.c,v 1.2 2004-09-30 11:06:41 adam Exp $ + * $Id: odr_mem.c,v 1.3 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file odr_mem.c + * \brief Implements ODR memory management */ #if HAVE_CONFIG_H #include diff --git a/src/odr_null.c b/src/odr_null.c index ac79240..ef2eb08 100644 --- a/src/odr_null.c +++ b/src/odr_null.c @@ -2,7 +2,11 @@ * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: odr_null.c,v 1.3 2004-08-11 12:15:38 adam Exp $ + * $Id: odr_null.c,v 1.4 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file odr_null.c + * \brief Implements ODR NULL codec */ #if HAVE_CONFIG_H #include diff --git a/src/odr_oct.c b/src/odr_oct.c index a3bd2a4..3d10943 100644 --- a/src/odr_oct.c +++ b/src/odr_oct.c @@ -2,7 +2,11 @@ * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: odr_oct.c,v 1.5 2004-10-02 13:28:26 adam Exp $ + * $Id: odr_oct.c,v 1.6 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file odr_oct.c + * \brief Implements ODR OCTET codec */ #if HAVE_CONFIG_H #include diff --git a/src/odr_oid.c b/src/odr_oid.c index 95d4447..6eb7dd8 100644 --- a/src/odr_oid.c +++ b/src/odr_oid.c @@ -2,7 +2,11 @@ * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: odr_oid.c,v 1.3 2004-08-13 07:30:06 adam Exp $ + * $Id: odr_oid.c,v 1.4 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file odr_oid.c + * \brief Implements ODR OID codec */ #if HAVE_CONFIG_H #include diff --git a/src/odr_seq.c b/src/odr_seq.c index c642ac1..7242943 100644 --- a/src/odr_seq.c +++ b/src/odr_seq.c @@ -1,11 +1,13 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: odr_seq.c,v 1.1 2003-10-27 12:21:34 adam Exp $ + * $Id: odr_seq.c,v 1.2 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file odr_seq.c + * \brief Implements ODR SEQUENCE codec */ - #if HAVE_CONFIG_H #include #endif diff --git a/src/odr_tag.c b/src/odr_tag.c index a8f31f2..d788ffe 100644 --- a/src/odr_tag.c +++ b/src/odr_tag.c @@ -1,9 +1,12 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: odr_tag.c,v 1.1 2003-10-27 12:21:34 adam Exp $ + * $Id: odr_tag.c,v 1.2 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file odr_tag.c + * \brief Implements ODR IMPLICIT tagging codec */ #if HAVE_CONFIG_H #include diff --git a/src/odr_use.c b/src/odr_use.c index 92e0363..509c445 100644 --- a/src/odr_use.c +++ b/src/odr_use.c @@ -1,9 +1,12 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: odr_use.c,v 1.1 2003-10-27 12:21:34 adam Exp $ + * $Id: odr_use.c,v 1.2 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file odr_use.c + * \brief Implements misc ODR types. */ #if HAVE_CONFIG_H #include diff --git a/src/odr_util.c b/src/odr_util.c index dc37ca3..0d4db2e 100644 --- a/src/odr_util.c +++ b/src/odr_util.c @@ -2,7 +2,11 @@ * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: odr_util.c,v 1.4 2004-08-11 12:15:38 adam Exp $ + * $Id: odr_util.c,v 1.5 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file odr_util.c + * \brief Implements various ODR utilities */ #if HAVE_CONFIG_H #include diff --git a/src/oid.c b/src/oid.c index ed33f02..d8bbf9b 100644 --- a/src/oid.c +++ b/src/oid.c @@ -1,11 +1,14 @@ /* - * Copyright (c) 1995-2003, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: oid.c,v 1.3 2003-11-19 22:24:57 adam Exp $ + * $Id: oid.c,v 1.4 2004-10-15 00:19:00 adam Exp $ */ -/* +/** + * \file oid.c + * \brief Implements OID database + * * More or less protocol-transparent OID database. * We could (and should?) extend this so that the user app can add new * entries to the list at initialization. diff --git a/src/opacdisp.c b/src/opacdisp.c index 237b2e2..3f40383 100644 --- a/src/opacdisp.c +++ b/src/opacdisp.c @@ -2,7 +2,11 @@ * Copyright (c) 2003-2004, Index Data. * See the file LICENSE for details. * - * $Id: opacdisp.c,v 1.2 2004-03-10 21:09:01 adam Exp $ + * $Id: opacdisp.c,v 1.3 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file opacdisp.c + * \brief Implements OPAC record display */ #include diff --git a/src/options.c b/src/options.c index ee836da..4f86d83 100644 --- a/src/options.c +++ b/src/options.c @@ -1,44 +1,12 @@ /* - * Copyright (c) 1995-2000, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss - * - * $Log: options.c,v $ - * Revision 1.1 2003-10-27 12:21:34 adam - * Source restructure. yaz-marcdump part of installation - * - * Revision 1.8 2000/02/29 13:44:55 adam - * Check for config.h (currently not generated). - * - * Revision 1.7 1999/11/30 13:47:12 adam - * Improved installation. Moved header files to include/yaz. - * - * Revision 1.6 1997/09/01 08:54:13 adam - * New windows NT/95 port using MSV5.0. Made prefix query handling - * thread safe. The function options ignores empty arguments when met. - * - * Revision 1.5 1995/12/06 13:00:19 adam - * Minus alone not treated as an option. - * - * Revision 1.4 1995/09/29 17:12:35 quinn - * Smallish - * - * Revision 1.3 1995/09/27 15:03:03 quinn - * Modified function heads & prototypes. - * - * Revision 1.2 1995/05/16 08:51:13 quinn - * License, documentation, and memory fixes - * - * Revision 1.1 1995/03/27 08:35:18 quinn - * Created util library - * Added memory debugging module. Imported options-manager - * - * Revision 1.2 1994/10/04 17:47:10 adam - * Function options now returns arg with error option. - * - * Revision 1.1 1994/08/16 15:57:22 adam - * The first utility modules. * + * $Id: options.c,v 1.2 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file options.c + * \brief Implements command line options parsing */ #if HAVE_CONFIG_H #include diff --git a/src/otherinfo.c b/src/otherinfo.c index 72de061..ecf0647 100644 --- a/src/otherinfo.c +++ b/src/otherinfo.c @@ -1,11 +1,13 @@ /* * Copyright (c) 1999-2003, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: otherinfo.c,v 1.1 2003-10-27 12:21:34 adam Exp $ + * $Id: otherinfo.c,v 1.2 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file otherinfo.c + * \brief Implements Z39.50 OtherInfo utilities */ - #include #include diff --git a/src/pquery.c b/src/pquery.c index bcaa487..f85e837 100644 --- a/src/pquery.c +++ b/src/pquery.c @@ -1,10 +1,13 @@ /* - * Copyright (c) 1995-2003, Index Data. + * Copyright (c) 1995-2004, Index Data. * See the file LICENSE for details. * - * $Id: pquery.c,v 1.1 2003-10-27 12:21:35 adam Exp $ + * $Id: pquery.c,v 1.2 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file pquery.c + * \brief Implements PQF parsing */ - #include #include #include diff --git a/src/prt-ext.c b/src/prt-ext.c index 9e8162d..b56d811 100644 --- a/src/prt-ext.c +++ b/src/prt-ext.c @@ -2,7 +2,12 @@ * Copyright (c) 1995-2004, Index Data. * See the file LICENSE for details. * - * $Id: prt-ext.c,v 1.2 2004-09-03 18:55:19 adam Exp $ + * $Id: prt-ext.c,v 1.3 2004-10-15 00:19:00 adam Exp $ + */ + +/** + * \file prt-ext.c + * \brief Implements handling of various Z39.50 Externals */ #include diff --git a/src/readconf.c b/src/readconf.c index 3b36874..3e99be0 100644 --- a/src/readconf.c +++ b/src/readconf.c @@ -1,56 +1,15 @@ /* - * Copyright (C) 1994-2000, Index Data + * Copyright (C) 1994-2004, Index Data * All rights reserved. - * Sebastian Hammer, Adam Dickmeiss - * - * $Log: readconf.c,v $ - * Revision 1.1 2003-10-27 12:21:35 adam - * Source restructure. yaz-marcdump part of installation - * - * Revision 1.10 2000/02/29 13:44:55 adam - * Check for config.h (currently not generated). - * - * Revision 1.9 1999/11/30 13:47:12 adam - * Improved installation. Moved header files to include/yaz. - * - * Revision 1.8 1999/08/27 09:40:32 adam - * Renamed logf function to yaz_log. Removed VC++ project files. - * - * Revision 1.7 1999/06/30 09:10:32 adam - * Fixed reading of MS-DOS files. - * - * Revision 1.6 1998/10/13 16:09:55 adam - * Added support for arbitrary OID's for tagsets, schemas and attribute sets. - * Added support for multiple attribute set references and tagset references - * from an abstract syntax file. - * Fixed many bad logs-calls in routines that read the various - * specifications regarding data1 (*.abs,*.att,...) and made the messages - * consistent whenever possible. - * Added extra 'lineno' argument to function readconf_line. - * - * Revision 1.5 1997/09/04 07:53:02 adam - * Added include readconf.h. - * - * Revision 1.4 1997/05/14 06:54:07 adam - * C++ support. - * - * Revision 1.3 1996/05/29 15:48:48 quinn - * Added \n to the isspace rule. - * - * Revision 1.2 1996/05/29 10:05:01 quinn - * Changed space criteria to support 8-bit characters - * - * Revision 1.1 1995/11/01 13:55:06 quinn - * Minor adjustments - * - * Revision 1.2 1995/10/30 13:54:27 quinn - * iRemoved fclose(). - * - * Revision 1.1 1995/10/10 16:28:18 quinn - * Initial revision - * * + * $Id: readconf.c,v 1.2 2004-10-15 00:19:00 adam Exp $ + */ + +/** + * \file readconf.c + * \brief Implements config file reading */ + #if HAVE_CONFIG_H #include #endif diff --git a/src/requestq.c b/src/requestq.c index bf9f7e2..97d371e 100644 --- a/src/requestq.c +++ b/src/requestq.c @@ -1,14 +1,12 @@ /* - * Copyright (C) 1994-2003, Index Data. + * Copyright (C) 1994-2004, Index Data. * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss - * - * $Id: requestq.c,v 1.1 2003-10-27 12:21:35 adam Exp $ * + * $Id: requestq.c,v 1.2 2004-10-15 00:19:00 adam Exp $ */ - -/* - * Simple queue management. +/** + * \file requestq.c + * \brief Implements Simple queue management for GFS. * * We also use the request-freelist to store encoding buffers, rather than * freeing and xmalloc'ing them on each cycle. diff --git a/src/service.c b/src/service.c index 3ed4a39..9add9b8 100644 --- a/src/service.c +++ b/src/service.c @@ -2,50 +2,13 @@ * NT Service interface Utility. * Based on code written by * Chas Woodfield, Fretwell Downing Informatics. - * $Log: service.c,v $ - * Revision 1.1 2003-10-27 12:21:35 adam - * Source restructure. yaz-marcdump part of installation - * - * Revision 1.5 2001/11/13 23:00:42 adam - * Separate malloc debug library. Removal of ASN_COMPILED-#ifdefs. - * - * Revision 1.4 2000/12/05 19:05:10 adam - * Service automatically starts in the directory from which it was installed. - * - * Revision 1.3 1999/06/10 11:45:30 adam - * Added bend_start, bend_stop handlers and removed pre_init. - * Handlers bend_start/bend_stop are called when service/daemon is - * started/stopped. - * - * Revision 1.2 1999/02/02 13:57:36 adam - * Uses preprocessor define WIN32 instead of WINDOWS to build code - * for Microsoft WIN32. - * - * Revision 1.1 1997/11/07 13:31:52 adam - * Added NT Service name part of statserv_options_block. Moved NT - * service utility to server library. - * - * Revision 1.6 1997/09/18 08:49:14 adam - * Option -runnormal no needed to run server in standalone mode. - * - * Revision 1.5 1997/09/17 12:10:43 adam - * YAZ version 1.4. - * - * Revision 1.4 1997/09/09 10:10:20 adam - * Another MSV5.0 port. Changed projects to include proper - * library/include paths. - * Server starts server in test-mode when no options are given. - * - * Revision 1.3 1997/09/04 13:50:30 adam - * Bug fix in ztest. - * + * $Id: service.c,v 1.2 2004-10-15 00:19:00 adam Exp $ */ -/************************************************************/ -/* Note this file is shared by all processes */ -/* Should really put it somewhere other than here */ -/* For some strange reason it won't work when part of a lib */ -/************************************************************/ +/** + * \file service.c + * \brief Implements NT service handling for GFS. + */ #ifdef WIN32 diff --git a/src/service.h b/src/service.h index 67fed2a..4a76ca9 100644 --- a/src/service.h +++ b/src/service.h @@ -2,17 +2,11 @@ * NT Service interface Utility. * Based on code written by * Chas Woodfield, Fretwell Downing Datasystems. - * $Log: service.h,v $ - * Revision 1.1 2003-10-27 12:21:35 adam - * Source restructure. yaz-marcdump part of installation - * - * Revision 1.1 1997/11/07 13:31:52 adam - * Added NT Service name part of statserv_options_block. Moved NT - * service utility to server library. - * - * Revision 1.2 1997/09/04 13:50:30 adam - * Bug fix in ztest. - * + * $Id: service.h,v 1.2 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file service.h + * \brief Header for NT service handling. */ #ifndef SERVICE_INCLUDED diff --git a/src/seshigh.c b/src/seshigh.c index f0b2ef9..93d8bc3 100644 --- a/src/seshigh.c +++ b/src/seshigh.c @@ -2,10 +2,12 @@ * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: seshigh.c,v 1.32 2004-10-09 08:21:38 adam Exp $ + * $Id: seshigh.c,v 1.33 2004-10-15 00:19:00 adam Exp $ */ - -/* +/** + * \file seshigh.c + * \brief Implements GFS session logic. + * * Frontend server logic. * * This code receives incoming APDUs, and handles client requests by means @@ -1371,7 +1373,7 @@ static Z_APDU *process_initRequest(association *assoc, request *reqb) assoc->init->implementation_name, odr_prepend(assoc->encode, "GFS", resp->implementationName)); - version = odr_strdup(assoc->encode, "$Revision: 1.32 $"); + version = odr_strdup(assoc->encode, "$Revision: 1.33 $"); if (strlen(version) > 10) /* check for unexpanded CVS strings */ version[strlen(version)-2] = '\0'; resp->implementationVersion = odr_prepend(assoc->encode, diff --git a/src/session.h b/src/session.h index bf196e4..f9c42e3 100644 --- a/src/session.h +++ b/src/session.h @@ -1,11 +1,13 @@ /* - * Copyright (C) 1995-2003, Index Data + * Copyright (C) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: session.h,v 1.1 2003-10-27 12:21:35 adam Exp $ + * $Id: session.h,v 1.2 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file session.h + * \brief Internal Header for GFS. */ - #ifndef SESSION_H #define SESSION_H diff --git a/src/siconv.c b/src/siconv.c index 7d31a00..c916cad 100644 --- a/src/siconv.c +++ b/src/siconv.c @@ -2,10 +2,17 @@ * Copyright (c) 1997-2004, Index Data * See the file LICENSE for details. * - * $Id: siconv.c,v 1.6 2004-08-07 08:18:19 adam Exp $ + * $Id: siconv.c,v 1.7 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file siconv.c + * \brief Implements simple ICONV + * + * This implements an interface similar to that of iconv and + * is used by YAZ to interface with iconv (if present). + * For systems where iconv is not present, this layer + * provides a few important conversion: UTF-8, MARC-8, Latin-1. */ - -/* mini iconv and wrapper for system iconv library (if present) */ #if HAVE_CONFIG_H #include diff --git a/src/soap.c b/src/soap.c index d2f38f8..8a10195 100644 --- a/src/soap.c +++ b/src/soap.c @@ -2,7 +2,14 @@ * Copyright (c) 2002-2004, Index Data. * See the file LICENSE for details. * - * $Id: soap.c,v 1.8 2004-10-02 13:28:26 adam Exp $ + * $Id: soap.c,v 1.9 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file soap.c + * \brief Implements SOAP + * + * This implements encoding and decoding of SOAP packages using + * Libxml2. */ #include diff --git a/src/sortspec.c b/src/sortspec.c index bc9e4b1..8d99a67 100644 --- a/src/sortspec.c +++ b/src/sortspec.c @@ -1,8 +1,12 @@ /* - * Copyright (c) 1995-2001, Index Data. + * Copyright (c) 1995-2004, Index Data. * See the file LICENSE for details. * - * $Id: sortspec.c,v 1.2 2004-05-10 07:48:56 adam Exp $ + * $Id: sortspec.c,v 1.3 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file sortspec.c + * \brief Implements SortSpec parsing. */ #include diff --git a/src/srw.c b/src/srw.c index afba33b..067e5f3 100644 --- a/src/srw.c +++ b/src/srw.c @@ -2,7 +2,11 @@ * Copyright (c) 2002-2004, Index Data. * See the file LICENSE for details. * - * $Id: srw.c,v 1.26 2004-10-02 13:28:26 adam Exp $ + * $Id: srw.c,v 1.27 2004-10-15 00:19:00 adam Exp $ + */ +/** + * \file srw.c + * \brief Implements SRW/SRU package encoding and decoding */ #include diff --git a/src/srwutil.c b/src/srwutil.c index 64292de..a809dd7 100644 --- a/src/srwutil.c +++ b/src/srwutil.c @@ -2,7 +2,11 @@ * Copyright (c) 2002-2004, Index Data. * See the file LICENSE for details. * - * $Id: srwutil.c,v 1.17 2004-10-09 08:49:55 adam Exp $ + * $Id: srwutil.c,v 1.18 2004-10-15 00:19:01 adam Exp $ + */ +/** + * \file srwutil.c + * \brief Implements SRW/SRU utilities. */ #include diff --git a/src/statserv.c b/src/statserv.c index cfe2ed0..817c031 100644 --- a/src/statserv.c +++ b/src/statserv.c @@ -5,7 +5,12 @@ * NT threaded server code by * Chas Woodfield, Fretwell Downing Informatics. * - * $Id: statserv.c,v 1.8 2004-05-10 10:47:04 adam Exp $ + * $Id: statserv.c,v 1.9 2004-10-15 00:19:01 adam Exp $ + */ + +/** + * \file statserv.c + * \brief Implements GFS logic */ #include diff --git a/src/tcpdchk.c b/src/tcpdchk.c index 5b9d234..fe5ce24 100644 --- a/src/tcpdchk.c +++ b/src/tcpdchk.c @@ -1,28 +1,12 @@ /* - * Copyright (c) 1995-2000, Index Data + * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss - * - * $Log: tcpdchk.c,v $ - * Revision 1.1 2003-10-27 12:21:35 adam - * Source restructure. yaz-marcdump part of installation - * - * Revision 1.5 2000/02/28 11:20:06 adam - * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL. - * - * Revision 1.4 1999/11/30 13:47:12 adam - * Improved installation. Moved header files to include/yaz. - * - * Revision 1.3 1999/08/27 09:40:32 adam - * Renamed logf function to yaz_log. Removed VC++ project files. - * - * Revision 1.2 1999/04/20 09:56:48 adam - * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun). - * Modified all encoders/decoders to reflect this change. - * - * Revision 1.1 1999/04/16 14:45:55 adam - * Added interface for tcpd wrapper for access control. * + * $Id: tcpdchk.c,v 1.2 2004-10-15 00:19:01 adam Exp $ + */ +/** + * \file tcpdchk.c + * \brief Implements TCP WRAPPER check. */ #include diff --git a/src/tcpip.c b/src/tcpip.c index 1136c9d..890dcc4 100644 --- a/src/tcpip.c +++ b/src/tcpip.c @@ -2,7 +2,11 @@ * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: tcpip.c,v 1.10 2004-09-21 14:59:01 adam Exp $ + * $Id: tcpip.c,v 1.11 2004-10-15 00:19:01 adam Exp $ + */ +/** + * \file tcpip.c + * \brief Implements TCP/IP + SSL COMSTACK. */ #include diff --git a/src/tpath.c b/src/tpath.c index 58ac639..a525a91 100644 --- a/src/tpath.c +++ b/src/tpath.c @@ -1,10 +1,14 @@ /* - * Copyright (c) 1995-2003, Index Data. + * Copyright (c) 1995-2004, Index Data. * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: tpath.c,v 1.1 2003-10-27 12:21:35 adam Exp $ + * $Id: tpath.c,v 1.2 2004-10-15 00:19:01 adam Exp $ */ +/** + * \file tpath.c + * \brief Implements path fopen + */ + #if HAVE_CONFIG_H #include #endif diff --git a/src/unix.c b/src/unix.c index 0ae3248..75ceb17 100644 --- a/src/unix.c +++ b/src/unix.c @@ -2,9 +2,14 @@ * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: unix.c,v 1.5 2004-09-21 14:59:01 adam Exp $ + * $Id: unix.c,v 1.6 2004-10-15 00:19:01 adam Exp $ * UNIX socket COMSTACK. By Morten Bøgeskov. */ +/** + * \file unix.c + * \brief Implements UNIX domain socket COMSTACK + */ + #ifndef WIN32 #include diff --git a/src/waislen.c b/src/waislen.c index 38ddf0a..b674e2a 100644 --- a/src/waislen.c +++ b/src/waislen.c @@ -1,28 +1,12 @@ /* - * Copyright (c) 1995-1999, Index Data. + * Copyright (c) 1995-2004, Index Data. * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss - * - * $Log: waislen.c,v $ - * Revision 1.1 2003-10-27 12:21:36 adam - * Source restructure. yaz-marcdump part of installation - * - * Revision 1.5 1999/11/30 13:47:11 adam - * Improved installation. Moved header files to include/yaz. - * - * Revision 1.4 1999/01/08 11:23:15 adam - * Added const modifier to some of the BER/ODR encoding routines. - * - * Revision 1.3 1996/02/29 14:23:13 adam - * Bug fix. - * - * Revision 1.2 1996/02/26 18:34:44 adam - * Bug fix. - * - * Revision 1.1 1996/02/20 13:02:58 quinn - * Wais length. - * * + * $Id: waislen.c,v 1.2 2004-10-15 00:19:01 adam Exp $ + */ +/** + * \file waislen.c + * \brief Implements WAIS package handling */ #include diff --git a/src/wrbuf.c b/src/wrbuf.c index 345a33e..9caf93c 100644 --- a/src/wrbuf.c +++ b/src/wrbuf.c @@ -2,11 +2,12 @@ * Copyright (c) 1995-2004, Index Data. * See the file LICENSE for details. * - * $Id: wrbuf.c,v 1.5 2004-10-01 11:44:46 adam Exp $ + * $Id: wrbuf.c,v 1.6 2004-10-15 00:19:01 adam Exp $ */ -/* - * Growing buffer for writing various stuff. +/** + * \file wrbuf.c + * \brief Implements WRBUF (growing buffer) */ #if HAVE_CONFIG_H diff --git a/src/xmalloc.c b/src/xmalloc.c index 4365eff..132d172 100644 --- a/src/xmalloc.c +++ b/src/xmalloc.c @@ -1,9 +1,12 @@ /* - * Copyright (C) 1994-2003, Index Data + * Copyright (C) 1994-2004, Index Data * All rights reserved. - * Sebastian Hammer, Adam Dickmeiss * - * $Id: xmalloc.c,v 1.1 2003-10-27 12:21:36 adam Exp $ + * $Id: xmalloc.c,v 1.2 2004-10-15 00:19:01 adam Exp $ + */ +/** + * \file xmalloc.c + * \brief Implements malloc interface. */ #if HAVE_CONFIG_H diff --git a/src/yaz-ccl.c b/src/yaz-ccl.c index 41ab879..87eab8d 100644 --- a/src/yaz-ccl.c +++ b/src/yaz-ccl.c @@ -1,8 +1,12 @@ /* - * Copyright (c) 1996-2003, Index Data. + * Copyright (c) 1996-2004, Index Data. * See the file LICENSE for details. * - * $Id: yaz-ccl.c,v 1.1 2003-10-27 12:21:36 adam Exp $ + * $Id: yaz-ccl.c,v 1.2 2004-10-15 00:19:01 adam Exp $ + */ +/** + * \file yaz-ccl.c + * \brief Implements CCL node tree to RPN converson. */ #include diff --git a/src/zgdu.c b/src/zgdu.c index fcd7be9..d7d76df 100644 --- a/src/zgdu.c +++ b/src/zgdu.c @@ -2,7 +2,12 @@ * Copyright (c) 2002-2004, Index Data. * See the file LICENSE for details. * - * $Id: zgdu.c,v 1.10 2004-08-11 12:15:38 adam Exp $ + * $Id: zgdu.c,v 1.11 2004-10-15 00:19:01 adam Exp $ + */ + +/** + * \file zgdu.c + * \brief Implements HTTP and Z39.50 encoding and decoding. */ #include diff --git a/src/zget.c b/src/zget.c index 17a7f77..d953e22 100644 --- a/src/zget.c +++ b/src/zget.c @@ -2,7 +2,11 @@ * Copyright (c) 1995-2004, Index Data. * See the file LICENSE for details. * - * $Id: zget.c,v 1.5 2004-05-10 07:48:56 adam Exp $ + * $Id: zget.c,v 1.6 2004-10-15 00:19:01 adam Exp $ + */ +/** + * \file zget.c + * \brief Implements Z39.50 package creator utilities */ #include diff --git a/src/zoom-c.c b/src/zoom-c.c index 2b51aa1..ad24eac 100644 --- a/src/zoom-c.c +++ b/src/zoom-c.c @@ -2,10 +2,13 @@ * Copyright (c) 2000-2004, Index Data * See the file LICENSE for details. * - * $Id: zoom-c.c,v 1.30 2004-10-02 13:28:26 adam Exp $ - * - * ZOOM layer for C, connections, result sets, queries. + * $Id: zoom-c.c,v 1.31 2004-10-15 00:19:01 adam Exp $ + */ +/** + * \file zoom-c.c + * \brief Implements ZOOM C interface. */ + #include #include #include "zoom-p.h" @@ -1001,7 +1004,7 @@ static zoom_ret ZOOM_connection_send_init (ZOOM_connection c) ZOOM_options_get(c->options, "implementationName"), odr_prepend(c->odr_out, "ZOOM-C", ireq->implementationName)); - version = odr_strdup(c->odr_out, "$Revision: 1.30 $"); + version = odr_strdup(c->odr_out, "$Revision: 1.31 $"); if (strlen(version) > 10) /* check for unexpanded CVS strings */ version[strlen(version)-2] = '\0'; ireq->implementationVersion = odr_prepend(c->odr_out, diff --git a/src/zoom-opt.c b/src/zoom-opt.c index 1f2dd45..bda3051 100644 --- a/src/zoom-opt.c +++ b/src/zoom-opt.c @@ -1,7 +1,12 @@ /* - * $Id: zoom-opt.c,v 1.1 2003-10-27 12:21:36 adam Exp $ + * Copyright (c) 2000-2004, Index Data + * See the file LICENSE for details. * - * ZOOM layer for C, options handling + * $Id: zoom-opt.c,v 1.2 2004-10-15 00:19:02 adam Exp $ + */ +/** + * \file zoom-opt.c + * \brief Implements ZOOM options handling */ #include #include "zoom-p.h" diff --git a/src/zoom-p.h b/src/zoom-p.h index 221a21e..54a2e6a 100644 --- a/src/zoom-p.h +++ b/src/zoom-p.h @@ -1,6 +1,12 @@ /* - * Private C header for ZOOM C. - * $Id: zoom-p.h,v 1.4 2004-02-23 09:26:11 adam Exp $ + * Copyright (c) 2000-2004, Index Data + * See the file LICENSE for details. + * + * $Id: zoom-p.h,v 1.5 2004-10-15 00:19:02 adam Exp $ + */ +/** + * \file zoom-p.h + * \brief Internal header for ZOOM implementation */ #include