ROBOTC.net forums
http://robotc.net/forums/

New version of HiTechnic Protoboard driver (0.6) + docs
http://robotc.net/forums/viewtopic.php?f=41&t=1283
Page 1 of 1

Author:  mightor [ Mon Mar 02, 2009 3:24 pm ]
Post subject:  New version of HiTechnic Protoboard driver (0.6) + docs

Hey guys,

I've greatly improved the documentation of this driver, you can take a peek here: [LINK].

You can download the driver from the Google Code download page: [LINK].

The documentation is also included with the zip file. The idea is that all drivers published from now on by me will be documented like this.

Regards,
Xander

Author:  chadgeorge [ Mon Mar 02, 2009 3:45 pm ]
Post subject:  Re: New version of HiTechnic Protoboard driver (0.6) + docs

Yes, I've used doxygen in the past when trying to figure out somebody else's code and found it to be very useful.
Its even more useful if you plan on using it and give it some hints (like you did)

One suggestion, since drivers will tend to be used in projects for a long time, it might be helpful to have some history of what the different released versions changed.

Author:  mightor [ Mon Mar 02, 2009 3:51 pm ]
Post subject:  Re: New version of HiTechnic Protoboard driver (0.6) + docs

Yeah, some of my drivers have a Changelog. However, I wrote this one a while back and I couldn't remember :) 0.6 is just a nice version number I knew wasn't going to conflict with any test version I had (like the one you posted the link to in the other forum).

A program (or driver) is only ever as good as its documentation and doxygen just makes it that much easier to do.

I intend to include examples and things like that in later versions, I just wanted to get this one out quick.

Regards,
Xander

Page 1 of 1 All times are UTC - 5 hours [ DST ]
Powered by phpBB © 2000, 2002, 2005, 2007 phpBB Group
http://www.phpbb.com/