Truth, Computing and Fail

I generally don’t rant on such well established open source projects simply because I’m not even remotely qualified to do so. But I’ll be making an exception this time. The bad cold I got more than a week back simply refuses to go away and poorly thought out documentation rules really raised my hackles this time.

Sample this from the struct fuse_operations documentation page:

int(* fuse_operations::write)(const char *, const char *, size_t, off_t, struct fuse_file_info *) 

Read the accompanying description. How is someone who is just starting off with FUSE supposed to know what the two char *’s are for? So off you go looking into source code provided by some tutorial and thereby waste at least 10 minutes in the process.

As it can be seen the docs have been generated by Doxygen. I know it’s “experimental” and all but is it really that difficult to write a bit more detailed comment on the function?