Difference between revisions of "FunctionInformation class"

From Catglobe Wiki
Jump to: navigation, search
Line 14: Line 14:
 
}}
 
}}
  
 
+
===Examples===
 
<source lang="javascript">
 
<source lang="javascript">
 
FunctionInformation info = new FunctionInformation("QAS_new");
 
FunctionInformation info = new FunctionInformation("QAS_new");

Revision as of 09:56, 19 December 2011

FunctionInformation



The FunctionInformation Object

Constructors

  • (string functionname "Method to get information on") - Get Information about a specific CGScript function

Methods

  • string ToString() - The string representation of the object.

Properties

  • string ObjectTypeName { get; } - The name of the type of object.
  • TypeInformation TypeInformation { get; } - Get information about this class.
  • string WikiDocumentation { get; } - Information about this function in wiki format.


Examples

FunctionInformation info = new FunctionInformation("QAS_new");

print(info.ToString());  
// result:  FunctionInformation

print(info.ObjectTypeName);
// result:  FunctionInformation

print(info.TypeInformation);
// result:  TypeInformation

print(info.WikiDocumentation);      
/* result:  
{{Function_Template|Name=QAS_new|ReturnType=Array
|Parameters=
|Name=<nowiki>Project Questionnaire unique id</nowiki>|ConstantType=Number,
|Name=<nowiki>User unique id</nowiki>|IsOptional=1|ConstantType=Number
}}
*/