Brian "Krow" Aker (krow) wrote,
Brian "Krow" Aker

libmemcached, Documentation...

This is a first. I documented an entire library and tools that I have been writing (aka the new C client for memcached).

Except for mod_layout, this is the first tool I've written that I have completely documented.

Really, I've never bothered to do this. And why is that?

Because normally I believe people should just read the code, but for once I am looking for lots of users so that I can get better testing. It is in my best interest to get as many people as possible to test libmemcached.

So what do I do to make this happen?

Document everything.

What a pain...

Most of what I write is for systems developers, and they typically read the .h files anyway. I document stuff I push to CPAN, but then that is made easy by h2xs.

The open question in my mind now, is if I should go back and put doxygen in everything.
  • Post a new comment


    Comments allowed for friends only

    Anonymous comments are disabled in this journal

    default userpic

    Your reply will be screened

    Your IP address will be recorded