Latest revision as of 06:48, 2 July 2020

FunctionInformation

Get information about this method

Parent class

Inherits from object

Constructors

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

Methods

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

Properties

Dictionary Documentation { get; } - Information about this function in dictionary format.
string ObjectTypeName { get; } - The name of the type of object.
(From 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.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
}}
*/

@@ Line 1: / Line 1: @@
 {{CGscriptClass_Template
 |Name=<nowiki>FunctionInformation</nowiki>
-|Description=<nowiki>The FunctionInformation Object </nowiki>
+|Description=<nowiki>Get information about this method</nowiki>
-|Constructors=
+|InheritsFrom=object|Constructors=
 {{CGscriptConstructors_Template|Parameters=
 {{CGscriptParameters_Template|Type=string|Name=<nowiki>functionname</nowiki>|Description=<nowiki>Method to get information on</nowiki>}}
-|Description=<nowiki>Get Information about a specific CGScript function</nowiki>}}
+|Description=<nowiki>Get Information about a specific function</nowiki>}}
 |Methods=
-{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
 |Properties=
+{{CGscriptProperties_Template|ReturnType=Dictionary|Name=<nowiki>Documentation</nowiki>|HasGetter=1|Description=<nowiki>Information about this function in dictionary format.</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>WikiDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about this function in wiki format.</nowiki>}}
 }}
+==== <span style="color:#a52a2a;">'''Examples'''</span>  ====
 <source lang="javascript">
@@ Line 22: / Line 25: @@
 print(info.ObjectTypeName);
 // result:  FunctionInformation
-print(info.TypeInformation);
-// result:  TypeInformation
 print(info.WikiDocumentation);
-// result:  {{Function_Template|Name=QAS_new|ReturnType=Array
+/* 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
 }}
+*/
 </source>