Template:ClassElement: Difference between revisions

Revision as of 00:06, 19 April 2007

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

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.
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.

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.

Anything more detailed about its purpose

Text here...

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;

Describe an example use of the foo class

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

@@ Line 1: / Line 1: @@
-<noinclude>This template is intended for use by engineer creating DOM subsystem description pages.
+<noinclude>USAGE:
+This template is intended for use by engineers creating DOM class description pages.
-USAGE:
 #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.
 #In the new blank page, type: <nowiki>{{subst:domclass}}</nowiki>
@@ Line 7: / Line 6: @@
 #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:
+The rest of this page shows what this template produces:
+----
 </noinclude>'''Summary:''' The '''foo class''' is part of the [[DOM foobar subsystem]]. It is an interface to inherit from for creating [[URI]] resolvers.