Discussion:
[xplc-general] Documentation!
Avery Pennarun
2003-12-05 15:34:05 UTC
Permalink
Last week I spent a bunch of time figuring out how XPLC works, so I added
some extra documentation to some of the most important interfaces, and
pphaneuf has now happily added the doxygen documentation to the web site:

http://xplc.sourceforge.net/doc/doxygen/annotated.html

There are still several undocumented interfaces, but I have the feeling from
talking to pphaneuf that these might change anyway, so perhaps you're better
off not knowing. The complete list of interfaces, documented or otherwise,
is here:

http://xplc.sourceforge.net/doc/doxygen/hierarchy.html

And before anyone asks, yes, it is *very* silly that I wrote doxygen docs
for XPLC before I wrote any for my own WvStreams. I feel that's okay,
though, because it's often better for someone other than the author to
document the interfaces: it means there are fewer implicit assumptions.
Since I had just spent a few hours learning how to use XPLC, I
remembered my assumptions pretty clearly, and I could write them down.

So, you too could be contributing to the XPLC docs! If you knew what the
classes did! If they did anything!

(Grumble grumble stupid evil IFactory grumble.)

Have fun,

Avery

Loading...