Template:APIClass

From FreeCAD Documentation
Revision as of 06:14, 7 December 2018 by Vocx (talk | contribs) (Category:Template:Text Format)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
{{{1}}}({{{2}}})

Description: {{{3}}}


This template is like Template:APIClass_b but includes a third argument to include a description of the class. It's meant to be the last element in a description.

Usage:

{{APIClass_b|class name|arguments with defaults}}
{{APIClass  |class name|arguments with defaults|long description}}

Example:

{{APIClass_b|BigClass|A, B}}
{{APIClass  |BigClass|Vector|uses the points ''A'' and ''B'', or a ''Vector''}}
BigClass(A, B)
BigClass(Vector)

Description: uses the points A and B, or a Vector