![[Home]](http://www.filtermeister.com/wiki/template_fm/logo.gif){kind=logo}
|
Use this template to document functions. You can copy its code from below for easy pasting.
---- = FunctionName = Requires FM 1.x Beta x.x (Month 20xx) or newer == Syntax == :type FunctionName(type arg, type arg2, ...) == Arguments == :arg ::Describe each individual argument, what it may contain and what it means. Including limitations :arg2 ::Each argument is described individualy. :... ::In case the argument is '...', specify what types are allowed. == Return == :Describe what, if anything, is returned by this function. Also list the meaning of error codes if applicable. == Description == :Describe the function here, including what it does, what the limits are, etc. == Example == <code> int a = FunctionName(1, 2, "test"); </code> == See Also == :(RelatedFunction)?, (OtherFunction)? == Comments == :Everyone can add their comments about their experiences with this function here. Tips for using it are welcome, too. ---- How it works: *If no value is returned, remove the first "type". *Functions with flexible types (ie sprintf) always use the ... notation. *If the function exists for more than one type (= overloaded), explicitly mention each function. I don't think we currently have any overloaded functions. *When not applicable, the Arguments, Return, Example and Also see sections may be removed. *Arguments should be listed in the order they appear in the function prototype/syntax. *Try to apply the Style Guide to all code examples. ---- RAW TEMPLATE CODE, FOR EASY COPY/PASTING <code> = FunctionName = Requires FM 1.x Beta x.x (Month 20xx) or newer == Syntax == :type name(type arg, ...) == Arguments == :arg ::specify. == Return == :specify. == Description == :specify. == Example == == See Also == :(specify)? == Comments == :Everyone can add their comments about their experiences with this function here. Tips for using it are welcome, too. </code> |