Differences

This shows you the differences between two versions of the page.

@@ Line 1: / Line 1: @@
+This is a template for code objects.
+====== ObjectName ======
+Object description.
+===== Functions =====
+==== functionName ====
+Function description.
+=== Syntax ===
+<code javascript>
+ObjectName.functionName(argument1, argument2);
+</code>
+=== Arguments ===
+  - argument1 - (type) argument description
+  - argument2 - (type) argument description
+=== Returns ===
+  * (type) return description
+=== Exceptions ===
+  * (exceptionType) exception description
+=== Example ===
+<code javascript>
+ObjectName.functionName(125, "data"); //Optional description
+</code>
+=== See also ===
+  * link
+=== Notes ===
+Notes.
+===== Methods =====
+==== methodName ====
+Method description.
+=== Syntax ===
+<code javascript>
+myObject.methodName(argument1, argument2);
+</code>
+=== Arguments ===
+  - argument1 - (type) argument description
+  - argument2 - (type) argument description
+=== Returns ===
+  * (type) return description
+=== Exceptions ===
+  * (exceptionType) exception description
+=== Example ===
+<code javascript>
+myObject.methodName(125, "data"); //Optional description
+</code>
+=== See also ===
+  * link
+=== Notes ===
+Notes.
+===== Enumerations =====
+==== enumerationName ====
+Enumeration description.
+=== Values ===
+  - value1: value description
+  - value2: value description
+  - value3: value description
+=== Example ===
+<code javascript>
+ObjectName.functionName(ObjectName.enumerationValue); //Optional description
+</code>
+=== See also ===
+  * link
+=== Notes ===
+Notes.
+===== Variables =====
+==== variableName ====
+Variable description.
+=== Example ===
+<code javascript>
+ObjectName.variableName = 42; //Optional description
+Script.print(ObjectName.variableName); //Optional description
+</code>
+=== See also ===
+  * link
+=== Notes ===
+Notes.
+===== Events =====
+==== eventName ====
+Event description.
+=== Syntax ===
+<code javascript>
+myObject.eventName = function(argument1, argument2) {};
+</code>
+=== Arguments ===
+  - argument1 - (type) argument description
+  - argument2 - (type) argument description
+=== Example ===
+<code javascript>
+myObject.eventName = function(argument1, argument2) {
+//Event action
+}; //Optional description
+</code>
+=== See also ===
+  * link
+=== Notes ===
+Notes.
+===== Attributes =====
+==== attributeName ====
+Attribute description.
+=== Example ===
+<code javascript>
+myObject.attributeName = 42; //Optional description
+Script.print(myObject.attributeName); //Optional description
+</code>
+=== See also ===
+  * link
+=== Notes ===
+Notes.