tokamak physics thread 3:

Blitz3D Forums/Blitz3D Programming/tokamak physics thread 3:

The forum is locked. These are the original blitzbasic.com forums, kept so they can still be read. No new topics, replies or edits can be made here. To join in, head over to the Blitz3D+ forums.

This is done automatically in Cod2Doc! The only thing is that Cod2Doc is not able (for now) to document directly a .decls file. But this is very easily done inside a .bb file like this:
; Creates the main simulator of Tokamak
; gravityX = the gravity along the x axis
; gravityY = the gravity along the y axis
; gravityZ = the gravity along the z axis
Function TOKSIM_CreateSimulator(gravityX#, gravityY#, gravityZ#)
End Function

; Creates a rigid body
; return = handle of the rigid body
Function TOKRB_Create()
End Function

; Add a box to a rigid body
; rigidBody = handle of the rigid body
; width = width of the box
; height = height of the box
; depth = depth of the box
; return = handle of the geometry (used for friction and restitution
Function TOKRB_AddBox(rigidBody, width#, height#, depth#)
End Function

Then, with Cod2Doc, you treat this .bb file. Put the option "functions only" + "highlight functions + quick help F1". And that's it -> Cod2Doc has automatically created the help files and put them into the Blitz folder.
(one thing to do is to erase the decls file created by Cod2Doc, as this one will conflict with the tokamak.decls file)

I put the result of this simple file on my web page:
http://repeatuntil.free.fr/tok/indexFunctions.html
Nice, no?? And that's a simple example, you could do more sophisticated... You can change easily the style too...
Hoping it gives you good idea ;)