Template:ClassElement

From COLLADA Public Wiki
Revision as of 00:06, 19 April 2007 by Elf (talk | contribs) (a little clarification in usage)
Jump to navigation Jump to search

USAGE: This template is intended for use by engineers creating DOM class description pages.

  1. Go to a new blank page--preferably by adding the article's name as a link in the COLLADA DOM API tutorial article and then clicking that link.
  2. In the new blank page, type: {{subst:domclass}}
  3. Save the page; this fills in the outline and sample text.
  4. Edit the page; replace "foo" with the name of the class. 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. 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?

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 class example

Describe an example use of the foo class

Related classes and functions

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

Function A

Summary
summary description
How it's used
blah blah

Function B

Summary
summary description
How it's used
blah blah