API docs updated nightly
mark at kingant.net
Sat Sep 29 19:07:15 EDT 2007
On Mon, 24 Sep 2007 15:57:02 -0400, Ethan Blanton wrote
> Luke Schierer spake unto us the following wisdom:
> > > Should the online API docs be built nightly at all? I'm of the
> > > opinion that they should probably be for the most recent released
> > > version, myself.
> > Released based API docs are best for plugin authors. MTN based API docs
> > are best for Summer of Code students, and those developers looking at
> > bugs in areas of the code they have not worked with in a while.
> My opinion is that anyone working on the codebase itself obviously
> has the source, and the documentation is in said source. There is
> no reason that a plugin author need have the source, however, which
> is why I believe the online documentation should reflect released versions.
> I personally find the header files and tags more useful than the
> doxygen output, myself, which is another reason I feel that
> up-to-the-minute web documentation is not as useful as release
> However, Daniel says we can have both -- which seems like the
> appropriate solution, to me.
Alright, it's now set up so that we have both old API docs and nightly API
The docs for specific revisions must be built and uploaded by hand. I only
added 2.0.0 and 2.2.0, but if other people want to add more feel free. Just
check out that tag, then "autogen.sh" then "make docs," update the entire
"doc" directory and put it in /home/var/doxygen/ and name it after that tag,
then add it to the http://developer.pidgin.im/Doxygen/ wiki page
Luke, I can change the nightly docs to be generated on pidgin.im (I have a
mostly-working script), but doxygen isn't installed. If you want to install
it (and graphviz dot, if it's not installed) and let me know I'll make final
More information about the Devel