1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
libcidr docs
This directory contains the various bits of documentation that describe
libcidr.
- libcidr.3 is a quick little manpage that provides a summary of the
functions, their calling convention, and a short description of what
they do. It's not meant to be more than a handy reference if you
need a function name or prototype quickly.
- reference/ contains the libcidr reference manual, which fully
documents each of the functions, along with suggestions for use and
any surprises or gotchas in their use. It's in a variety of formats,
all generated from the SGML source. This uses the codelibrary DTD
<http://www.over-yonder.net/~fullermd/projects/sgml/codelibrary>
which I originally developed for libpostal <http://libpostal.sf.net/>
and which is designed specifically for documenting libraries.
Although they're not technically documentation, the example/ and test/
programs in the library src directory give good examples of how the
functions can be used. cidr_to_str(), for instance, has a huge number
of options, which the test/mkstr/ program can let you play with easily.
--
Matt
|
