| Volumes Of Fun http://www.volumesoffun.com/phpBB3/ |
|
| Requested documentation improvement http://www.volumesoffun.com/phpBB3/viewtopic.php?f=15&t=267 |
Page 1 of 1 |
| Author: | DragonM [ Wed Sep 21, 2011 9:30 pm ] |
| Post subject: | Requested documentation improvement |
Some of the simpler classes and methods are missing documentation. In particular, I needed to know if Region::containsPoint() returned strictly less than the upper point or less than or equal and strictly greater than the lower point or greater than or equal. I had to read the code to find out that "contains" includes equal. It would be nice if there was a Doxygen comment on containsPoint() describing its behavior precisely. I'm not looking at it right now, but I'd imagine there are a number of methods of the Vector template that would also benefit from such clarification. Thanks. |
|
| Author: | David Williams [ Thu Sep 22, 2011 10:16 pm ] |
| Post subject: | Re: Requested documentation improvement |
It's hard to argue with the value of good documentation and I do agree that this is an area where more work is needed. The problem is that things keep changing so it's something that needs to be kept up to date. I think the Vector class is ok but I will make a note to add some documentation to the Region class. But really I would like to add some higher level documentation explaining why things are the way they are, and to address some of the usage questions which come up quite frequently. Well, now we have a bug for it, so I'll leave this open until it's done... |
|
| Page 1 of 1 | All times are UTC |
| Powered by phpBB © 2000, 2002, 2005, 2007 phpBB Group http://www.phpbb.com/ |
|