Next: Playing in the mudbox, Previous: Contributing source documentation, Up: Contributing to Marsyas
_ after member
variables (“member variables” are variables which can be used
throughout the class). In other words, in your .h files use:
class MyMar: public MarSystem
{
private:
mrs_real varname_; // don't use a plain "varname"
...
}
exit(0) upon successful completion. If any problems arise, the
program should return a number greater than 0.
ansi style defined in
Artistic Style; our exact style
file is in misc/astylerc. To use the file, call
astyle --options=/path/to/marsyas_topdir/misc/astylerc filename.cpp
‘filename.cpp’ can include wildcards, ie ‘*.h’ and ‘*.cpp’.
This style changes the positions of braces {}, tab indentation,
and a few other whitespace issues. These issues are somewhat personal
and we can almost guarantee that everybody will hate some aspect
of the style, but having a uniform style makes it much easier to
understand (and fix bugs in!) unfamiliar code. You do not need to
format your source code according to this file, but don't complain if
your file is modified accordingly.
Unfortunately due to historical reasons these last two points are not consistant within the Marsyas source code.