[ODE] Submitting documentation

[Russ Smith]

hi martin,

more documentation is greatly appreciated!

the documentation source is in ode/doc/ode.doc. it's a simple text file
with a bunch of commands to control formatting, like @section{name} and
@code{...}. the perl script called 'doccer' in the same directory is used
to convert the documentation into HTML, use

  doccer ode.doc > ode.html

the complete set of formatting commands are described at the top of the
files 'doccer' and 'snarf'.

as for the mass functions - i've been using the convention that mass
setting functions take the density, not the total mass (e.g.
dMassSetSphere() and friends). the total mass is determined by the size of
the object that is specified. but it you want to specify the total mass
and not the density, then you call dMassAdjust() giving it the previously
initialized mass object and the new total mass.

russ.

--
Russ Smith
http://www.q12.org/

On Fri, 30 May 2003, Martin C. Martin wrote:

> Hey Russ,
>
> I'm working on some changes; I've now got joint limits and motors in the
> Universal joint, and some utility functions to set a dMass if you know the
> total mass rather than the density.  I'd like to clean them up and submit
> them, and I figure I'd better write some simple documentation for them
> too.  How do you edit the manual?  Raw HTML in a text editor?  If so, I'll
> send HTML diffs.  If not, I guess I'll just send text and you'll have to
> do the formatting.  Or some other format?  Just let me know.
>
> And while we're at it, what prototype would you prefer to the "total mass"
> functions?  I've been using:
>
> void dMassSetSphereTotal (dMass *, dReal total_mass, dReal radius);
>
> would you prefer something else?
>
> - Martin
> _______________________________________________
> ODE mailing list
> ODE@q12.org
> http://q12.org/mailman/listinfo/ode
>