It is currently Sat Aug 08, 2020 8:33 pm

All times are UTC

Post new topic Reply to topic  [ 2 posts ] 
Author Message
 Post subject: Requested documentation improvement
PostPosted: Wed Sep 21, 2011 9:30 pm 

Joined: Sun Jul 10, 2011 2:15 am
Posts: 12
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.


Offline Profile  
Reply with quote  
 Post subject: Re: Requested documentation improvement
PostPosted: Thu Sep 22, 2011 10:16 pm 
User avatar

Joined: Sun May 04, 2008 6:35 pm
Posts: 1827
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...

Offline Profile  
Reply with quote  
Display posts from previous:  Sort by  
Post new topic Reply to topic  [ 2 posts ] 

All times are UTC

Who is online

Users browsing this forum: No registered users and 1 guest

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
Theme created