clean up headers + add manual title

git-svn-id: https://www.opensc-project.org/svnp/opensc/trunk@2216 c6295689-39f2-0310-b995-f0e70906c6a9
This commit is contained in:
bert 2005-03-01 23:18:24 +00:00
parent 923b4b5217
commit d8729db066
9 changed files with 47 additions and 12 deletions

View File

@ -1,4 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="sccardvalid"> <refentry id="sccardvalid">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta> <refmeta>
<refentrytitle>sc_card_valid</refentrytitle> <refentrytitle>sc_card_valid</refentrytitle>
<manvolnum>3</manvolnum> <manvolnum>3</manvolnum>
@ -14,7 +16,7 @@
<title>Synopsis</title> <title>Synopsis</title>
<para> <para>
<programlisting> <programlisting>
&includes; #include &lt;opensc.h&gt;
int sc_card_valid(const <link linkend="sccardt">sc_card_t</link> *card); int sc_card_valid(const <link linkend="sccardt">sc_card_t</link> *card);
</programlisting> </programlisting>

View File

@ -1,4 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scconnectcard"> <refentry id="scconnectcard">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta> <refmeta>
<refentrytitle>sc_connect_card</refentrytitle> <refentrytitle>sc_connect_card</refentrytitle>
<manvolnum>3</manvolnum> <manvolnum>3</manvolnum>
@ -14,7 +16,7 @@
<title>Synopsis</title> <title>Synopsis</title>
<para> <para>
<programlisting> <programlisting>
&includes; #include &lt;opensc.h&gt;
int sc_connect_card(sc_reader_t *reader, int slot, <link linkend="sccardt">sc_card_t</link> **card); int sc_connect_card(sc_reader_t *reader, int slot, <link linkend="sccardt">sc_card_t</link> **card);
</programlisting> </programlisting>
@ -40,4 +42,9 @@ int sc_connect_card(sc_reader_t *reader, int slot, <link linkend="sccardt">sc_ca
</para> </para>
</refsect1> </refsect1>
<refsect1>
<title>Return value</title>
<para>Returns 0 if successful, or a negative value in case of error.</para>
</refsect1>
</refentry> </refentry>

View File

@ -1,4 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scdetectcardpresence"> <refentry id="scdetectcardpresence">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta> <refmeta>
<refentrytitle>sc_detect_card_presence</refentrytitle> <refentrytitle>sc_detect_card_presence</refentrytitle>
<manvolnum>3</manvolnum> <manvolnum>3</manvolnum>
@ -14,7 +16,7 @@
<title>Synopsis</title> <title>Synopsis</title>
<para> <para>
<programlisting> <programlisting>
&includes; #include &lt;opensc.h&gt;
int sc_detect_card_presence(sc_reader_t *reader, int slot_id); int sc_detect_card_presence(sc_reader_t *reader, int slot_id);
</programlisting> </programlisting>

View File

@ -1,4 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scdisconnectcard"> <refentry id="scdisconnectcard">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta> <refmeta>
<refentrytitle>sc_disconnect_card</refentrytitle> <refentrytitle>sc_disconnect_card</refentrytitle>
<manvolnum>3</manvolnum> <manvolnum>3</manvolnum>
@ -14,7 +16,7 @@
<title>Synopsis</title> <title>Synopsis</title>
<para> <para>
<programlisting> <programlisting>
&includes; #include &lt;opensc.h&gt;
int sc_disconnect_card(<link linkend="sccardt">sc_card_t</link> *card, int action); int sc_disconnect_card(<link linkend="sccardt">sc_card_t</link> *card, int action);
</programlisting> </programlisting>
@ -37,4 +39,9 @@ int sc_disconnect_card(<link linkend="sccardt">sc_card_t</link> *card, int actio
</para> </para>
</refsect1> </refsect1>
<refsect1>
<title>Return value</title>
<para>Returns 0 if successful, or a negative value in case of error.</para>
</refsect1>
</refentry> </refentry>

View File

@ -1,4 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scestablishcontext"> <refentry id="scestablishcontext">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta> <refmeta>
<refentrytitle>sc_establish_context</refentrytitle> <refentrytitle>sc_establish_context</refentrytitle>
<manvolnum>3</manvolnum> <manvolnum>3</manvolnum>
@ -14,7 +16,7 @@
<title>Synopsis</title> <title>Synopsis</title>
<para> <para>
<programlisting> <programlisting>
&includes; #include &lt;opensc.h&gt;
int sc_establish_context(sc_context_t **ctx, int sc_establish_context(sc_context_t **ctx,
const char *appname); const char *appname);
@ -75,4 +77,9 @@ typedef struct sc_reader {
</para> </para>
</refsect1> </refsect1>
<refsect1>
<title>Return value</title>
<para>Returns 0 if successful, or a negative value in case of error.</para>
</refsect1>
</refentry> </refentry>

View File

@ -1,4 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scgetcachedir"> <refentry id="scgetcachedir">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta> <refmeta>
<refentrytitle>sc_get_cache_dir</refentrytitle> <refentrytitle>sc_get_cache_dir</refentrytitle>
<manvolnum>3</manvolnum> <manvolnum>3</manvolnum>
@ -14,7 +16,7 @@
<title>Synopsis</title> <title>Synopsis</title>
<para> <para>
<programlisting> <programlisting>
&includes; #include &lt;opensc.h&gt;
int sc_get_cache_dir(struct sc_context *ctx, char *buf, size_t bufsize); int sc_get_cache_dir(struct sc_context *ctx, char *buf, size_t bufsize);
</programlisting> </programlisting>

View File

@ -1,4 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scmakecachedir"> <refentry id="scmakecachedir">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta> <refmeta>
<refentrytitle>sc_make_cache_dir</refentrytitle> <refentrytitle>sc_make_cache_dir</refentrytitle>
<manvolnum>3</manvolnum> <manvolnum>3</manvolnum>
@ -14,7 +16,7 @@
<title>Synopsis</title> <title>Synopsis</title>
<para> <para>
<programlisting> <programlisting>
&includes; #include &lt;opensc.h&gt;
int sc_make_cache_dir(struct sc_context *ctx); int sc_make_cache_dir(struct sc_context *ctx);
</programlisting> </programlisting>

View File

@ -1,4 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="screleasecontext"> <refentry id="screleasecontext">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta> <refmeta>
<refentrytitle>sc_release_context</refentrytitle> <refentrytitle>sc_release_context</refentrytitle>
<manvolnum>3</manvolnum> <manvolnum>3</manvolnum>
@ -14,7 +16,7 @@
<title>Synopsis</title> <title>Synopsis</title>
<para> <para>
<programlisting> <programlisting>
&includes; #include &lt;opensc.h&gt;
int sc_release_context(sc_context_t *ctx); int sc_release_context(sc_context_t *ctx);
</programlisting> </programlisting>
@ -29,9 +31,11 @@ int sc_release_context(sc_context_t *ctx);
to <link linkend="scestablishcontext">sc_establish_context()</link>. No further calls to OpenSC to <link linkend="scestablishcontext">sc_establish_context()</link>. No further calls to OpenSC
using this context are possible after this. using this context are possible after this.
</para> </para>
</refsect1>
<para> <refsect1>
</para> <title>Return value</title>
<para>This function always return 0, indicating success.</para>
</refsect1> </refsect1>
</refentry> </refentry>

View File

@ -1,4 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scsetcarddriver"> <refentry id="scsetcarddriver">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta> <refmeta>
<refentrytitle>sc_set_card_driver</refentrytitle> <refentrytitle>sc_set_card_driver</refentrytitle>
<manvolnum>3</manvolnum> <manvolnum>3</manvolnum>
@ -14,7 +16,7 @@
<title>Synopsis</title> <title>Synopsis</title>
<para> <para>
<programlisting> <programlisting>
&includes; #include &lt;opensc.h&gt;
int sc_set_card_driver(struct sc_context *ctx, const char *short_name); int sc_set_card_driver(struct sc_context *ctx, const char *short_name);
</programlisting> </programlisting>