Doxygen documentation on Newton.h?

[godlike]

Hi all,

I've been reading the Newton's documentation in the wiki and also going though the source code. Newton.h summarizes the library's public interface in a very clean way which is a big plus (I've been quite skeptical with the state of documentation in other opensource physics libraries). So I was thinking what if Newton.h had full doxygen documentation and if that can be used to generate wiki pages (or something else). The idea is that the documentation updates happen in the source code and -with minimal effort- they end up in the wiki as well.

Is that something worth exploring? If yes I can do some research on the feasibility.

This is how the doxygen comments will look like:

Code: Select all

/**
 * @brief Creates a new world.
 *
 * This is the command that creates a Newton world, which holds all of your Rigid Bodies, Collision data, etc.
 * although you can theoretically have more than 1 World in an application, most situations only require a single world.
 *
 * @note Function NewtonSetMemorySystem should be called before creating a world.
 */
NEWTON_API NewtonWorld* NewtonCreate ();

PS: To be honest I am not sure the wiki documentation is already auto-generated. Couldn't find something that suggests that.

[AntonSynytsia]

Automatic documentation generators is a very good idea. Maybe someone could get their hands on to create Doxygen documentation for the Newton.cpp.

I have been using Yardoc documentation tool for all my projects written on Ruby. Yardoc's mark-up syntax looks very similar to Doxygen. I wouldn't mind helping out writing the Docs for Newton.

Let's see what Juleo has to say about this.

http://en.wikipedia.org/wiki/Doxygen

[godlike]

Cool. If Julio thinks that this is going to be useful I would love to help out as well