Template:ClassElement: Difference between revisions
Jump to navigation
Jump to search
template for eng's |
(No difference)
|
Revision as of 21:07, 16 March 2007
This template is intended for use by engineer creating DOM subsystem description pages.
USAGE:
- Create a new blank page--preferably by adding a link to it in the COLLADA DOM API tutorial article.
- In the new blank page, type: {{subst:domclass}}
- Save the page; this fills in the outline and sample text.
- Edit the page; replace "foo" with the name of the class. Make any other edits and save the page.
This is 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