ruby libusb documentation

Yay documentation! I documented most of the methods is libusb but I’m not sure it really makes anything that much clearer if you don’t already have a fairly good understanding of the USB device specification. Anyways, take a look around and tell me what you think!

One Comment

  1. In my opinion, the most important thing for making API documentation like that useful is to give a synopsis of the whole package on the main doc page. Perldoc traditionally is very good about this (for example, Ruby is traditionally very bad about it.

    Without that, it’s hard to get a high-level overview of what all these objects are and why I want them. Your example programs probably help to clarify, but when I click on them I can’t actually see the code in the API documentation.

    Other than that, this looks like pretty good documentation.

Leave a Reply