Template:ClassElement

From COLLADA Public Wiki
Jump to: navigation, search

USAGE: This template is intended for use by engineers creating class or element description pages. To use this template:

  1. Go to a new blank page--preferably by adding the article's name as a link to some related or summary article and then clicking that link.
  2. In the new blank page, type: {{subst:ClassElement}}
  3. Save the page; this fills in the outline and sample text.
  4. Edit the page; replace "foo" with the name of the class or element. Make any other edits and save the page.

The rest of this page shows what this template produces:


Summary: The foo class is part of the DOM foobar subsystem. Or the <foo> element is part of the <blah> element. It is an interface to inherit from for creating URI resolvers.

Purpose

Anything more detailed about its purpose.

Text here...

How it's used

Where and how might an application apply this class or element?

Each blah blah blah...

When it finds the correct one, it calls resolve_URI and passes the following struct:

typedef struct {
  int foo;
  char *name;
  enum { a, b } 
} datablah;

Foo example

Describe an example use of the foo class

Attributes

This element has the following attributes:

  • blah: Interacts with the bar element and frammistanis the glompus.
  • name: blah blah

Related classes and functions

This section briefly describes what each function in this class is used for.

Related elements

Child elements

  • list
  • child
  • elements

Parent elements

  • list
  • parent
  • elements

Function A

Summary
summary description
How it's used
blah blah

Function B

Summary
summary description
How it's used
blah blah

See also

External links