Documentation

ProfessionalUser
Posts: 14
Joined: Fri Oct 14, 2011 12:10 am

Documentation

Post by ProfessionalUser »

Hi there,

I came to realize that the documentation of bullet is insufficient. The pdf file is a great first read but it merely scratches the surface. Doxygen comments inside the code are quite sparse. The Wiki only discusses certain topics. The examples are great for reference but only present a small subset of what's possible or how to approach a specific problem. The forum seems to be the last resort of finding missing information. Often I can't find the solution on there. I find myself experimenting a lot and even scrutinizing the .cpp to find out what a method is actually doing. This is very inefficient really.

I think the bullet SDK could be greatly improved by bringing the documentation up to standard. Please take a look at the documentation of Qt for reference. What I'd like to see is a thorough description for every class, every method, every parameter and every data member.

May I ask if there are any plans to improve the bullet SDK documentation?

Kind regards,
Chris
User avatar
dphil
Posts: 237
Joined: Tue Jun 29, 2010 10:27 pm

Re: Documentation

Post by dphil »

Please see/continue the relevant discussion here: http://bulletphysics.org/Bullet/phpBB3/ ... 0&start=60