search

behdad / box2d

Automatically exported from code.google.com/p/box2d
2 stars 12 forks source link

Outdated API documentation #225

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
As far as I can tell, the API documentation in the SVN trunk 
(Box2D/Documentation/API) has only been generated once back in April 2010, and 
is now not reflecting the current API.

The attached patch creates a 'doc' target so that the documentation can be 
generated easily. If Doxygen is present, 'make clean' will wipe out 
Box2D/Documentation/API, and 'make doc' will recreate it from the source files.

Maybe you'll want to still ship pre-built documentation in the zip releases, 
for people who do not want to install Doxygen, but it's probably best to remove 
it from SVN if this patch is accepted.

Cheers,

-- 
Benoît Knecht

Original issue reported on code.google.com by benoit.k...@gmail.com on 2 Aug 2011 at 7:43

Attachments:

GoogleCodeExporter commented 9 years ago 
The trunk documentation is almost always out of date. I could exclude the 
Doxygen documentation but I need to keep the manual in there so I don't lose 
it. So we still have a situation where the trunk documentation is out of date. 
I do agree that there is no point to having the Doxygen output in SVN so I have 
deleted it.

I do not wish to modify the build system now since I may be switching to a new 
system soon. Thanks.

Original comment by erinca...@gmail.com on 23 Aug 2011 at 4:12