Libpcap 1.0, WinPcap and documentation

["Gianluca Varenni" <gianluca.varenni () cacetech com>]

Hi all.

I've just seen that all the documentation of libpcap has been migrated from 
a single pcap.3 file to single .3pcap files, one per function (more or 
less).

Within WinPcap I have a big problem in generating the documentation. Within 
WinPcap we generate html with doxygen out of an (outdated) version of 
pcap.h. In the past it was a pain because the pcap.h file used for the 
documentation was never up-to-date.
The problem is that now pcap\pcap.h doesn't contain any documentation, and 
several new functions have been added to libpcap (pcap_create, pcap_activate 
and so on).

In the past we (WinPcap team) discussed about rewriting the documentation 
within pcap.h using the doxygen commenting style, and then generate both man 
pages (for *nix systems) and html pages out of it. Of course this would 
either require putting doxygen as a prerequisite to build the libpcap man 
pages on *nix (a bad thing, for sure) or committing the doxygen-generated 
man pages to the CVS when pcap.h gets updated. Or (3rd option) I will just 
deal with manually converting the existing pcap-*.3pcap files to some 
documentation format suitable for doxygen and keep everything up to date.

Any thoughts/ideas/suggestions?

Have a nice day
GV

Attachment: smime.p7s
Description: