XMLClef explanation of what XMLClef is and/or does
Inherits from: Object
More detailed prose description of XMLClef.
See also: Object [some other help files]
Some Important Issues Regarding XMLClef (optional)
Explanation of the issues. For more information see Nil and [some other help files].
Creation / Class Methods
*new (clefType, line)
Short prose description of method.
clefType - Explanation of clefType. Default value is nil. Other information.
line - Explanation of line. Default value is nil. Other information.
// inline example
g = XMLClef.new;
g.doSomething; // explanation
g.cleanUpMethod;
*treble
Short prose description of method.
// inline example
g = XMLClef.treble;
g.doSomething; // explanation
g.cleanUpMethod;
*bass
Short prose description of method.
// inline example
g = XMLClef.bass;
g.doSomething; // explanation
g.cleanUpMethod;
*alto
Short prose description of method.
// inline example
g = XMLClef.alto;
g.doSomething; // explanation
g.cleanUpMethod;
*soprano
Short prose description of method.
// inline example
g = XMLClef.soprano;
g.doSomething; // explanation
g.cleanUpMethod;
*tenor
Short prose description of method.
// inline example
g = XMLClef.tenor;
g.doSomething; // explanation
g.cleanUpMethod;
Accessing Instance and Class Variables
clefType
Explanation including the type of clefType and a link to its help file.
Default value is nil.
Doing Some Task (optional)
A short bit of prose explaining something about the task.
initXMLClef
Short prose description of method.
// inline example
g = XMLClef.initXMLClef;
g.doSomething; // explanation
g.cleanUpMethod;
appendAttributes (tree, doc)
Short prose description of method.
tree - Explanation of tree. Default value is nil. Other information.
doc - Explanation of doc. Default value is nil. Other information.
// inline example
g = XMLClef.appendAttributes;
g.doSomething; // explanation
g.cleanUpMethod;
Examples
// what this example does
e = XMLClef.new;
e.instanceMethod(someObject);
e.cleanUp;
...