projects
/
yazpp-moved-to-github.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
71b4559
)
use <synopsis> instead of <screen>; put synopses outside paragraphs (same style as...
author
Mike Taylor
<mike@indexdata.com>
Wed, 9 Oct 2002 11:44:44 +0000
(11:44 +0000)
committer
Mike Taylor
<mike@indexdata.com>
Wed, 9 Oct 2002 11:44:44 +0000
(11:44 +0000)
doc/zoom.xml
patch
|
blob
|
history
diff --git
a/doc/zoom.xml
b/doc/zoom.xml
index
709a295
..
7aac7d8
100644
(file)
--- a/
doc/zoom.xml
+++ b/
doc/zoom.xml
@@
-1,5
+1,5
@@
<chapter id="zoom">
<chapter id="zoom">
- <!-- $Id: zoom.xml,v 1.3 2002-10-09 09:07:10 mike Exp $ -->
+ <!-- $Id: zoom.xml,v 1.4 2002-10-09 11:44:44 mike Exp $ -->
<title>ZOOM-C++</title>
<sect1 id="zoom.introduction">
<title>ZOOM-C++</title>
<sect1 id="zoom.introduction">
@@
-27,7
+27,8
@@
<!-- ### there must be a better way to mark up a book title? -->
<emphasis>The Complete Dinosaur</emphasis>
from the Library of Congress's Z39.50 server:
<!-- ### there must be a better way to mark up a book title? -->
<emphasis>The Complete Dinosaur</emphasis>
from the Library of Congress's Z39.50 server:
- <screen>
+ </para>
+ <synopsis>
#include <iostream>
#include <yaz++/zoom.h>
#include <iostream>
#include <yaz++/zoom.h>
@@
-41,7
+42,8
@@
const record *rec = rs.getRecord(0);
cout << rec->render() << endl;
}
const record *rec = rs.getRecord(0);
cout << rec->render() << endl;
}
- </screen>
+ </synopsis>
+ <para>
(Note that, for the sake of simplicity, this does not check for
errors: we show a more realistic version of this program later.)
</para>
(Note that, for the sake of simplicity, this does not check for
errors: we show a more realistic version of this program later.)
</para>
@@
-110,7
+112,8
@@
</para>
<para>
The class has this declaration:
</para>
<para>
The class has this declaration:
- <screen>
+ </para>
+ <synopsis>
class connection {
public:
connection (const char *hostname, int portnum);
class connection {
public:
connection (const char *hostname, int portnum);
@@
-118,8
+121,7
@@
const char *option (const char *key) const;
const char *option (const char *key, const char *val);
};
const char *option (const char *key) const;
const char *option (const char *key, const char *val);
};
- </screen>
- </para>
+ </synopsis>
<para>
### discusson
</para>
<para>
### discusson
</para>
@@
-142,28
+144,28
@@
<title><literal>ZOOM::prefixQuery</literal></title>
<para>
The class has this declaration:
<title><literal>ZOOM::prefixQuery</literal></title>
<para>
The class has this declaration:
- <screen>
+ </para>
+ <synopsis>
class prefixQuery : public query {
public:
prefixQuery (const char *pqn);
~prefixQuery ();
};
class prefixQuery : public query {
public:
prefixQuery (const char *pqn);
~prefixQuery ();
};
- </screen>
- </para>
+ </synopsis>
</sect2>
<sect2>
<title><literal>ZOOM::CCLQuery</literal></title>
<para>
The class has this declaration:
</sect2>
<sect2>
<title><literal>ZOOM::CCLQuery</literal></title>
<para>
The class has this declaration:
- <screen>
+ </para>
+ <synopsis>
class CCLQuery : public query {
public:
CCLQuery (const char *ccl, void *qualset);
~CCLQuery ();
};
class CCLQuery : public query {
public:
CCLQuery (const char *ccl, void *qualset);
~CCLQuery ();
};
- </screen>
- </para>
+ </synopsis>
</sect2>
<sect2>
</sect2>
<sect2>
@@
-194,7
+196,8
@@
</para>
<para>
The class has this declaration:
</para>
<para>
The class has this declaration:
- <screen>
+ </para>
+ <synopsis>
class resultSet {
public:
resultSet (connection &c, const query &q);
class resultSet {
public:
resultSet (connection &c, const query &q);
@@
-204,8
+207,7
@@
size_t size () const;
const record *getRecord (size_t i) const;
};
size_t size () const;
const record *getRecord (size_t i) const;
};
- </screen>
- </para>
+ </synopsis>
<para>
### discusson
</para>
<para>
### discusson
</para>
@@
-224,7
+226,8
@@
</para>
<para>
The class has this declaration:
</para>
<para>
The class has this declaration:
- <screen>
+ </para>
+ <synopsis>
class record {
public:
~record ();
class record {
public:
~record ();
@@
-236,8
+239,7
@@
const char *render () const;
const char *rawdata () const;
};
const char *render () const;
const char *rawdata () const;
};
- </screen>
- </para>
+ </synopsis>
<para>
### discusson
</para>
<para>
### discusson
</para>
@@
-254,14
+256,16
@@
The <literal>ZOOM::exception</literal> class is a virtual base
class, representing a diagnostic generated by the ZOOM-C++ library
or returned from a server. ###
The <literal>ZOOM::exception</literal> class is a virtual base
class, representing a diagnostic generated by the ZOOM-C++ library
or returned from a server. ###
- <screen>
+ </para>
+ <synopsis>
class exception {
public:
exception (int code);
int errcode () const;
const char *errmsg () const;
};
class exception {
public:
exception (int code);
int errcode () const;
const char *errmsg () const;
};
- </screen>
+ </synopsis>
+ <para>
This class has three (so far) concrete subclasses:
</para>
This class has three (so far) concrete subclasses:
</para>
@@
-269,22
+273,23
@@
<title><literal>ZOOM::systemException</literal></title>
<para>
The class has this declaration:
<title><literal>ZOOM::systemException</literal></title>
<para>
The class has this declaration:
- <screen>
+ </para>
+ <synopsis>
class systemException: public exception {
public:
systemException ();
int errcode () const;
const char *errmsg () const;
};
class systemException: public exception {
public:
systemException ();
int errcode () const;
const char *errmsg () const;
};
- </screen>
- </para>
+ </synopsis>
</sect2>
<sect2>
<title><literal>ZOOM::bib1Exception</literal></title>
<para>
The class has this declaration:
</sect2>
<sect2>
<title><literal>ZOOM::bib1Exception</literal></title>
<para>
The class has this declaration:
- <screen>
+ </para>
+ <synopsis>
class bib1Exception: public exception {
public:
bib1Exception (int errcode, const char *addinfo);
class bib1Exception: public exception {
public:
bib1Exception (int errcode, const char *addinfo);
@@
-292,15
+297,15
@@
const char *errmsg () const;
const char *addinfo () const;
};
const char *errmsg () const;
const char *addinfo () const;
};
- </screen>
- </para>
+ </synopsis>
</sect2>
<sect2>
<title><literal>ZOOM::queryException</literal></title>
<para>
The class has this declaration:
</sect2>
<sect2>
<title><literal>ZOOM::queryException</literal></title>
<para>
The class has this declaration:
- <screen>
+ </para>
+ <synopsis>
class queryException: public exception {
public:
static const int PREFIX = 1;
class queryException: public exception {
public:
static const int PREFIX = 1;
@@
-310,8
+315,7
@@
const char *errmsg () const;
const char *addinfo () const;
};
const char *errmsg () const;
const char *addinfo () const;
};
- </screen>
- </para>
+ </synopsis>
</sect2>
<sect2>
</sect2>
<sect2>