View unanswered posts | View active topics It is currently Tue Sep 30, 2014 9:30 pm






Reply to topic  [ 3 posts ] 
New version of HiTechnic Protoboard driver (0.6) + docs 
Author Message
Moderator
Moderator
User avatar

Joined: Wed Mar 05, 2008 8:14 am
Posts: 3223
Location: Rotterdam, The Netherlands
Post 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

_________________
| Professional Conduit of Reasonableness
| (Title bestowed upon on the 8th day of November, 2013)
| My Blog: I'd Rather Be Building Robots
| ROBOTC 3rd Party Driver Suite: [Project Page]


Mon Mar 02, 2009 3:24 pm
Profile WWW
Novice

Joined: Fri Oct 24, 2008 8:58 am
Posts: 87
Post 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.


Mon Mar 02, 2009 3:45 pm
Profile
Moderator
Moderator
User avatar

Joined: Wed Mar 05, 2008 8:14 am
Posts: 3223
Location: Rotterdam, The Netherlands
Post 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

_________________
| Professional Conduit of Reasonableness
| (Title bestowed upon on the 8th day of November, 2013)
| My Blog: I'd Rather Be Building Robots
| ROBOTC 3rd Party Driver Suite: [Project Page]


Mon Mar 02, 2009 3:51 pm
Profile WWW
Display posts from previous:  Sort by  
Reply to topic   [ 3 posts ] 

Who is online

Users browsing this forum: No registered users and 2 guests


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Search for:
Jump to:  



Powered by phpBB © 2000, 2002, 2005, 2007 phpBB Group.
Designed by ST Software for PTF.