Hi Niels, The Doxygen patch applies cleanly to the libevent trunk as of August 3rd.
If you like the idea of self-documenting code, I could redo the patch to annotate the real event.h and evdns.h, instead of creating a copy in the doxygen/ subdirectory. This makes it easier to keep the code and documentation in sync in the future; when you change the code, change the documentation with it. If the two things are kept separate, they can fall out of sync more easily. Also you may be interested in a project of mine called pnotify. It is like libevent but for filesystem events; for example, the EVFILT_VNODE events for kqueue, and the inotify(7) facility for Linux. It provides a portable way to watch for events such as file creation, modification, and deletion. The project web page is http://mark.heily.com/pnotify and it is already very functional and ported to all BSDs, MacOS, and Linux. I think it might be a good candidate for importing into the libevent tree in the same way you did with evdns. This would allow people to add callbacks for filesystem events that would be integrated with the libevent main loop. Best regards, Mark On Mon, 2007-07-30 at 20:32 -0700, Niels Provos wrote: > Hi Mark, > > I am slowly catching up on my email back log. Could you please check > if your doxygen patch still works against trunk? > > Thank you, > Niels. > > On 4/30/07, Mark Heily <[EMAIL PROTECTED]> wrote: > > Here are the annotated header files and the Doxygen configuration file > > that can be used to generate the libevent API reference manual found at > > http://naturalc.org/libevent/. > > > > This patch creates the following files: > > > > doxygen/ > > doxygen/Doxyfile > > doxygen/event.h > > doxygen/evdns.h > > doxygen/evhttp.h > > > > It also modifies Makefile.am to include these files in the source > > tarball when running 'make dist'. > > > > After applying the patch, go to the doxygen/ subdirectory and run > > 'doxygen' to generate the documentation. > > > > Regards, > > > > - Mark > > > > P.S. For legal purposes, > > > > I, Mark Heily, hereby place the following modifications to libevent into > > the public domain. Hence, these modifications may be freely used and/or > > redistributed for any purpose with or without attribution and/or other > > notice. > > > > diff -ruN ../libevent.OLD/doxygen/Doxyfile ./doxygen/Doxyfile > > --- ../libevent.OLD/doxygen/Doxyfile 1969-12-31 19:00:00.000000000 -0500 > > +++ ./doxygen/Doxyfile 2007-04-30 23:02:31.000000000 -0400 > > @@ -0,0 +1,226 @@ > > +# Doxyfile 1.5.1 > > + > > +# This file describes the settings to be used by the documentation system > > +# doxygen (www.doxygen.org) for a project > > +# _______________________________________________ Libevent-users mailing list Libevent-users@monkey.org http://monkey.org/mailman/listinfo/libevent-users
