Skip to content

Commit 2471d3e

Browse files
futatukifutatuki
committed
libopendkim: Updating API documents
1 parent 756a38f commit 2471d3e

10 files changed

+614
-1
lines changed

‎libopendkim/docs/Makefile.am

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ dist_doc_DATA = dkim.html \
1212
dkim_cbstat.html \
1313
dkim_chunk.html \
1414
dkim_close.html \
15+
dkim_code_to_name.html \
1516
dkim_dns_close.html \
1617
dkim_dns_config.html \
1718
dkim_dns_init.html \
@@ -48,11 +49,17 @@ dist_doc_DATA = dkim.html \
4849
dkim_getuser.html \
4950
dkim_header.html \
5051
dkim_init.html \
52+
dkim_iter_ctx.html \
53+
dkim_iter_ctx_free.html \
5154
dkim_key_syntax.html \
5255
dkim_lib.html \
5356
dkim_libfeature.html \
5457
dkim_libversion.html \
5558
dkim_minbody.html \
59+
dkim_name_to_code.html \
60+
dkim_nametable.html \
61+
dkim_nametable_first.html \
62+
dkim_nametable_next.html \
5663
dkim_ohdrs.html \
5764
dkim_options.html \
5865
dkim_param_t.html \

‎libopendkim/docs/dkim_code_to_name.html

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
<html>
2+
<head><title>dkim_code_to_name()</title></head>
3+
<body>
4+
<!--
5+
-->
6+
<h1>dkim_code_to_name()</h1>
7+
<p align="right"><a href="index.html">[back to index]</a></p>
8+
9+
<table border="0" cellspacing=4 cellpadding=4>
10+
<!---------- Synopsis ----------->
11+
<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
12+
<pre>
13+
#include &lt;dkim.h&gt;
14+
const char *dkim_code_to_name(
15+
<a href="dkim_nametable.html"><tt>DKIM_NAMETABLE</tt></a> *tbl,
16+
const int *code
17+
);
18+
</pre>
19+
Translate a mnemonic code to its name in C string.
20+
</td></tr>
21+
22+
<!----------- Description ---------->
23+
<tr><th valign="top" align=left>DESCRIPTION</th><td>
24+
<table border="1" cellspacing=1 cellpadding=4>
25+
<tr align="left" valign=top>
26+
<th width="80">Called When</th>
27+
<td><tt>dkim_code_to_name()</tt> can be called at any time.</td>
28+
</tr>
29+
</table>
30+
31+
<!----------- Arguments ---------->
32+
<tr><th valign="top" align=left>ARGUMENTS</th><td>
33+
<table border="1" cellspacing=0>
34+
<tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
35+
<tr valign="top"><td>tbl</td>
36+
<td>A name table to use for translation. One of values described in
37+
<a href="dkim_nametable.html"><tt>DKIM_NAMETABLE</tt>.
38+
</td></tr>
39+
<tr valign="top"><td>code</td>
40+
<td>A code to translate.</td></tr>
41+
</table>
42+
</td></tr>
43+
44+
<!----------- Return Values ---------->
45+
<tr>
46+
<th valign="top" align=left>RETURN VALUES</th>
47+
<td>
48+
<ul>
49+
<li>Pointer to the name matching the provided code, if found
50+
<li><tt>NULL</tt>, if no maching is found
51+
</ul>
52+
</td>
53+
</tr>
54+
55+
<!----------- Notes ---------->
56+
<tr>
57+
<th valign="top" align=left>NOTES</th>
58+
<td>
59+
<ul>
60+
<li>None.
61+
</ul>
62+
</td>
63+
</tr>
64+
65+
</table>
66+
67+
<hr size="1">
68+
<font size="-1">
69+
Copyright (c) 2005, 2007 Sendmail, Inc. and its suppliers.
70+
All rights reserved.
71+
<br>
72+
Copyright (c) 2009-2014, 2024 The Trusted Domain Project. All rights reserved.
73+
74+
<br>
75+
By using this file, you agree to the terms and conditions set
76+
forth in the respective licenses.
77+
</font>
78+
</body>
79+
</html>

‎libopendkim/docs/dkim_iter_ctx.html

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<html>
2+
<head><title>DKIM_ITER_CTX</title></head>
3+
<body>
4+
<!--
5+
-->
6+
<h1>DKIM_NAMETABLE_CTX</h1>
7+
<p align="right"><a href="index.html">[back to index]</a></p>
8+
9+
<table border="0" cellspacing=4 cellpadding=4>
10+
<!----------- Description ---------->
11+
<tr><th valign="top" align=left>DESCRIPTION</th><td>
12+
<table border="1" cellspacing=1 cellpadding=4>
13+
<tr align="left" valign=top>
14+
<th width="80">Purpose</th>
15+
<td>A <tt>DKIM_ITER_CTX</tt> stores a context in a iteration
16+
over a table (currently support <tt>DKIM_NAMETABLE</tt> only).
17+
It is created by <a href="dkim_nametable_first.html"><tt
18+
>dkim_nametable_first()</tt></a> function and must be freed by the
19+
caler by using <a href="dkim_iter_ctx_free.html"><tt
20+
>dkim_iter_free()</tt></a> function.
21+
</td>
22+
</tr>
23+
</table>
24+
25+
<!----------- Notes ---------->
26+
<tr>
27+
<th valign="top" align=left>NOTES</th>
28+
<td>
29+
<ul>
30+
<li>This is passed as the first parameter to
31+
<a href="dkim_nametable_next.html"
32+
><tt>dkim_nametable_next()</tt></a>.
33+
</ul>
34+
</td>
35+
</tr>
36+
</table>
37+
38+
<hr size="1">
39+
<font size="-1">
40+
Copyright (c) 2008 Sendmail, Inc. and its suppliers.
41+
All rights reserved.
42+
<br>
43+
Copyright (c) 2009-2014, 2024, The Trusted Domain Project.
44+
All rights reserved.
45+
46+
<br>
47+
By using this file, you agree to the terms and conditions set
48+
forth in the respective licenses.
49+
</font>
50+
</body>
51+
</html>

‎libopendkim/docs/dkim_iter_ctx_free.html

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
<html>
2+
<head><title>dkim_iter_ctx_free()</title></head>
3+
<body>
4+
<!--
5+
-->
6+
<h1>dkim_iter_ctx_free()</h1>
7+
<p align="right"><a href="index.html">[back to index]</a></p>
8+
9+
<table border="0" cellspacing=4 cellpadding=4>
10+
<!---------- Synopsis ----------->
11+
<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
12+
<pre>
13+
#include &lt;dkim.h&gt;
14+
<a href="dkim_stat.html"><tt>DKIM_STAT</tt></a> dkim_iter_ctx_free(
15+
<a href="dkim_iter_ctx.html"
16+
><tt>DKIM_ITER_CTX</tt></a> *ctx
17+
);
18+
</pre>
19+
Release resources associated with a nametable iteration context.
20+
</td></tr>
21+
22+
<!----------- Description ---------->
23+
<tr><th valign="top" align=left>DESCRIPTION</th><td>
24+
<table border="1" cellspacing=1 cellpadding=1>
25+
<tr align="left" valign=top>
26+
<th width="80">Called When</th>
27+
<td><tt>dkim_iter_ctx_free()</tt> must be passed a table iteration context
28+
returned by
29+
<a href="dkim_nametable_first.html"><tt>dkim_nametable_first()</tt></a></td>
30+
</tr>
31+
<tr align="left" valign=top>
32+
<th width="80">Effects</th>
33+
<td>Releases resources that were allocated and assigned to the context
34+
<tt>ctx</tt> when it was returned by <tt>dkim_nametable_first()</tt>.
35+
The context <tt>ctx</tt> may not be reused. </td>
36+
</tr>
37+
</table>
38+
39+
<!----------- Arguments ---------->
40+
<tr><th valign="top" align=left>ARGUMENTS</th><td>
41+
<table border="1" cellspacing=0>
42+
<tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
43+
<tr valign="top"><td>ctx</td>
44+
<td> A <tt>DKIM_ITER_CTX</tt> context returned by
45+
a previous call to <tt>dkim_nametable_first()</tt>.
46+
</td></tr>
47+
</table>
48+
</td></tr>
49+
50+
<!----------- Return values ---------->
51+
<tr>
52+
<th valign="top" align=left>RETURN VALUES</th>
53+
54+
<td>
55+
<ul>
56+
<li><tt>DKIM_STAT_OK</tt> -- operation was successful
57+
</ul>
58+
59+
</td>
60+
</tr>
61+
62+
<!----------- Notes ---------->
63+
<tr align="left" valign=top>
64+
<th>NOTES</th>
65+
<td>
66+
67+
None.
68+
</td>
69+
</tr>
70+
71+
</table>
72+
73+
<hr size="1">
74+
<font size="-1">
75+
Copyright (c) 2005, 2006 Sendmail, Inc. and its suppliers.
76+
All rights reserved.
77+
<br>
78+
Copyright (c) 2009-2014, 2024 The Trusted Domain Project. All rights reserved.
79+
80+
<br>
81+
By using this file, you agree to the terms and conditions set
82+
forth in the respective licenses.
83+
</font>
84+
</body>
85+
</html>

‎libopendkim/docs/dkim_name_to_code.html

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
<html>
2+
<head><title>dkim_name_to_code()</title></head>
3+
<body>
4+
<!--
5+
-->
6+
<h1>dkim_name_to_code()</h1>
7+
<p align="right"><a href="index.html">[back to index]</a></p>
8+
9+
<table border="0" cellspacing=4 cellpadding=4>
10+
<!---------- Synopsis ----------->
11+
<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
12+
<pre>
13+
#include &lt;dkim.h&gt;
14+
const int dkim_name_to_code(
15+
<a href="dkim_nametable.html"><tt>DKIM_NAMETABLE</tt></a> *tbl,
16+
const char *name
17+
);
18+
</pre>
19+
Translate a name text in C string into a mnemonic code.
20+
</td></tr>
21+
22+
<!----------- Description ---------->
23+
<tr><th valign="top" align=left>DESCRIPTION</th><td>
24+
<table border="1" cellspacing=1 cellpadding=4>
25+
<tr align="left" valign=top>
26+
<th width="80">Called When</th>
27+
<td><tt>dkim_name_to_code()</tt> can be called at any time.</td>
28+
</tr>
29+
</table>
30+
31+
<!----------- Arguments ---------->
32+
<tr><th valign="top" align=left>ARGUMENTS</th><td>
33+
<table border="1" cellspacing=0>
34+
<tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
35+
<tr valign="top"><td>tbl</td>
36+
<td>A name table to use for translation. One of values described in
37+
<a href="dkim_nametable.html"><tt>DKIM_NAMETABLE</tt>.
38+
</td></tr>
39+
<tr valign="top"><td>code</td>
40+
<td>A name C string to translate.</td></tr>
41+
</table>
42+
</td></tr>
43+
44+
<!----------- Return Values ---------->
45+
<tr>
46+
<th valign="top" align=left>RETURN VALUES</th>
47+
<td>
48+
<ul>
49+
<li>A mnemonic code matching the provided name, if found
50+
<li><tt>-1</tt>, if no maching is found
51+
</ul>
52+
</td>
53+
</tr>
54+
55+
<!----------- Notes ---------->
56+
<tr>
57+
<th valign="top" align=left>NOTES</th>
58+
<td>
59+
<ul>
60+
<li>None.
61+
</ul>
62+
</td>
63+
</tr>
64+
65+
</table>
66+
67+
<hr size="1">
68+
<font size="-1">
69+
Copyright (c) 2005, 2007 Sendmail, Inc. and its suppliers.
70+
All rights reserved.
71+
<br>
72+
Copyright (c) 2009-2014, 2024 The Trusted Domain Project. All rights reserved.
73+
74+
<br>
75+
By using this file, you agree to the terms and conditions set
76+
forth in the respective licenses.
77+
</font>
78+
</body>
79+
</html>

‎libopendkim/docs/dkim_nametable.html

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
<html>
2+
<head><title>DKIM_NAMETABLE</title></head>
3+
<body>
4+
<!--
5+
-->
6+
<h1>DKIM_NAMETABLE</h1>
7+
<p align="right"><a href="index.html">[back to index]</a></p>
8+
9+
<table border="0" cellspacing=4 cellpadding=4>
10+
<!----------- Description ---------->
11+
<tr><th valign="top" align=left>DESCRIPTION</th><td>
12+
<table border="1" cellspacing=1 cellpadding=4>
13+
<tr align="left" valign=top>
14+
<th width="80">Purpose</th>
15+
<td>A <tt>DKIM_NAMETABLE</tt> is a conversion table between an internal code
16+
in <tt>libopendkim</tt> and its name text in C string. It is passed as
17+
a parameter to the conversion functions
18+
<a href="dkim_code_to_name.html"><tt>dkim_code_to_name()</tt></a> or
19+
<a href="dkim_name_to_code.html"><tt>dkim_name_to_code()</tt></a>.
20+
For the purpose to aquire all data in a table, there are functions
21+
to allow us iteration on a table,
22+
<a href="dkim_nametable_first.html"><tt
23+
>dkim_nametable_first()</tt></a>,
24+
<a href="dkim_nametable_next.html"><tt
25+
>dkim_nametable_next()</tt></a>, and
26+
<a href="dkim_iter_ctx_free.html"><tt
27+
>dkim_iter_free()</tt></a>.
28+
</td>
29+
</tr>
30+
<tr align="left" valign=top>
31+
<th width="80">Possible Values</th>
32+
<td>
33+
<ul>
34+
<li> <tt>dkim_table_algorithms</tt> -- a conversion table for
35+
<a href="dkim_alg_t.html"><tt>dkim_alg_t</tt></a>.</li>
36+
<li> <tt>dkim_talbe_canonicalizations</tt> -- a conversion table for
37+
<a href="dkim_canon_t.html"><tt>dkim_canon_t</tt></a>.</li>
38+
<li> <tt>dkim_table_keyflags</tt> -- a conversion table for
39+
<tt>DKIM_SIGFLAG_*</tt> constants.</li>
40+
<li> <tt>dkim_table_querytypes</tt> -- a conversion table for
41+
<tt>DKIM_QUERY_*</tt> constants.</li>
42+
<li> <tt>dkim_table_results</tt> -- a conversion table for
43+
<a href="dkim_stat.html"><tt>DKIM_STAT</tt></a> constants.</li>
44+
<li> <tt>dkim_table_sigerrors</tt> -- a conversion table for
45+
<a href="dkim_sigerror.html"><tt>DKIM_SIGERROR</tt></a> constants.</li>
46+
<li> <tt>dkim_table_sigparams</tt> -- a conversion table for
47+
<tt>DKIM_PARAM_*</tt> constants.</li>
48+
</ul>
49+
</td></tr>
50+
</table>
51+
52+
</td></tr>
53+
</table>
54+
55+
<hr size="1">
56+
<font size="-1">
57+
Copyright (c) 2008 Sendmail, Inc. and its suppliers.
58+
All rights reserved.
59+
<br>
60+
Copyright (c) 2009-2014, 2024, The Trusted Domain Project.
61+
All rights reserved.
62+
63+
<br>
64+
By using this file, you agree to the terms and conditions set
65+
forth in the respective licenses.
66+
</font>
67+
</body>
68+
</html>

0 commit comments

Comments
 (0)