Adapted documentation for ips.

This commit is contained in:
mainzelm 2003-02-10 12:38:40 +00:00
parent 45223c1d81
commit e75388ad14
1 changed files with 13 additions and 3 deletions

View File

@ -463,15 +463,25 @@ field but we where no able to find test cases for them.
\section{IP Addresses as Dotted Strings} \section{IP Addresses as Dotted Strings}
\textbf{Should live in its own package} %
\begin{description}
\item[Used files:] ip.scm
\item[Name of the package:] ips
\end{description}
%
The structure \ex{ips} provides a small set of procedures for turning
the human-readable form of IP addresses (``dotted strings'') into 32
bits numbers.
\defun{address32->ip-string}{\ipaddr}{ip-string} \defun{address32->ip-string}{\ipaddr}{ip-string}
\defun{ip-string->address32}{ip-string}{\ipaddr} \defun{ip-string->address32}{ip-string}{\ipaddr}
\defun{ip-string?}{string}{\boolean} \defun{ip-string?}{string}{\boolean}
\begin{desc} \begin{desc}
Tests whether \var{string} represents a valid IPv4 address. Tests whether \var{string} is a valid dotted string for an IP
\oops{not yet implemented} address.
\end{desc} \end{desc}
%%% Local Variables: %%% Local Variables:
%%% mode: latex %%% mode: latex