search

ofTheo / ofxKinect

legacy openFrameworks wrapper for the xbox kinect (OF pre-0.8.0+ only) - ofxKinect is now included and is being maintained in OF releases
MIT License
540 stars 105 forks source link

Where are the comments when adding new functions etc? #51

Closed danomatika closed 12 years ago

danomatika commented 13 years ago

I see a bunch of new functions etc that have been added here and there over time and no comments!

For instance, what do the following functions return? meters, mm, cm, km, float 0-1, ... ?

float getDistanceAt(int x, int y);
float getDistanceAt(const ofPoint & p);

Sure, "self documented code" and all that, but in this case we need to know what we are getting back.

It dosen't take very much time to comment your work and helps the rest of us out. More and more people are using this addon and, so far, the headers are their only source of documentation.

As far as I'm concerned, an update isn't finished until its been commented and tested. Also, I find having to explain an addition in a sentence or 2 is a good usability test.

kylemcdonald commented 13 years ago

this is a good point. could you close this by putting a comment after these that says "in centimeters"? i think the only note of cm is in the implementation.

in retrospect, getDistanceCentimeters would have been a better name.

danomatika commented 13 years ago

The name is fine. I don't think we need to go the obj-c route or anything, just need to know what we are getting.

I don't want to close this until we've gone through the code since there are a few more places as well. Best to avoid any confusion for newcomers.

danomatika commented 12 years ago

Nice to see all the nice commenting going on ... :P

danomatika commented 12 years ago

We are finally fixing this ...