C# Class BindingsGenerator.Symbol

显示文件 Open project: realXtend/tundra-urho3d Class Usage Examples

Public Properties

Property Type Description
argList string
author string
baseClasses List
briefDescription string
bugs List
children List
classMemberIndexTitle string
detailedDescription string
documentationCategory string
filename string
fullDefinition string
groupSyntax bool
id string
inbodyDescription string
includes List
isConst bool
isExplicit bool
isMutable bool
isStatic bool
kind string
macroBody string
name string
notes List
otherOverloads List
parameters List
parent Symbol
path string
returnComment string
seeAlsoDocumentation string
similarOverload Symbol
sourceFileEndLine int
sourceFileStartLine int
sourceFilename string
todos List
type string
value string
virtualness Virtualness
visibilityLevel VisibilityLevel

Public Methods

Method Description
ArgStringWithoutTypes ( ) : string
ArrayLength ( ) : int
BriefComment ( ) : string
Category ( ) : string
ClassCtor ( ) : Symbol

If this Symbol is a class or a struct, returns the child symbol that is considered to be the ctor of this class.
ClassIndexDocFilename ( ) : string
Comments ( ) : string[]
FindChildByName ( string name ) : Symbol
FindParamByName ( string paramName ) : Parameter
FullQualifiedSymbolName ( ) : string
FullQualifiedSymbolNameWithoutNamespace ( ) : string
IsArray ( ) : bool
IsConst ( ) : bool
IsNumberType ( string type ) : bool
IsPODType ( string type ) : bool
MemberDocumentationFilename ( ) : string
MemberDocumentationFilenameWithoutFileSuffix ( ) : string
NameWithoutNamespace ( ) : string
Namespace ( ) : string
ScopeName ( ) : string
ScopeNameWithoutNamespace ( ) : string

Private Methods

Method Description
EscapeFilename ( string s ) : string

Method Details

ArgStringWithoutTypes() public method

public ArgStringWithoutTypes ( ) : string
return string

ArrayLength() public method

public ArrayLength ( ) : int
return int

BriefComment() public method

public BriefComment ( ) : string
return string

Category() public method

public Category ( ) : string
return string

ClassCtor() public method

If this Symbol is a class or a struct, returns the child symbol that is considered to be the ctor of this class.
public ClassCtor ( ) : Symbol
return Symbol

ClassIndexDocFilename() public method

public ClassIndexDocFilename ( ) : string
return string

Comments() public method

public Comments ( ) : string[]
return string[]

FindChildByName() public method

public FindChildByName ( string name ) : Symbol
name string
return Symbol

FindParamByName() public method

public FindParamByName ( string paramName ) : Parameter
paramName string
return Parameter

FullQualifiedSymbolName() public method

public FullQualifiedSymbolName ( ) : string
return string

FullQualifiedSymbolNameWithoutNamespace() public method

public FullQualifiedSymbolNameWithoutNamespace ( ) : string
return string

IsArray() public method

public IsArray ( ) : bool
return bool

IsConst() public method

public IsConst ( ) : bool
return bool

IsNumberType() public static method

public static IsNumberType ( string type ) : bool
type string
return bool

IsPODType() public static method

public static IsPODType ( string type ) : bool
type string
return bool

MemberDocumentationFilename() public method

public MemberDocumentationFilename ( ) : string
return string

MemberDocumentationFilenameWithoutFileSuffix() public method

public MemberDocumentationFilenameWithoutFileSuffix ( ) : string
return string

NameWithoutNamespace() public method

public NameWithoutNamespace ( ) : string
return string

Namespace() public method

public Namespace ( ) : string
return string

ScopeName() public method

public ScopeName ( ) : string
return string

ScopeNameWithoutNamespace() public method

public ScopeNameWithoutNamespace ( ) : string
return string

Property Details

argList public_oe property

public string argList
return string

author public_oe property

public string author
return string

baseClasses public_oe property

If this symbol is a class or a struct, this refers to the symbols that are the base classes of this class, or an empty list if no inheritance is used. \todo This has not been implemented yet. Doxygen has BaseclassName elements, implement this!
public List baseClasses
return List

briefDescription public_oe property

public string briefDescription
return string

bugs public_oe property

public List bugs
return List

children public_oe property

public List children
return List

classMemberIndexTitle public_oe property

Specifies under which name this symbol will be present in the class member index. If empty, this member will be hidden from the index.
public string classMemberIndexTitle
return string

detailedDescription public_oe property

public string detailedDescription
return string

documentationCategory public_oe property

public string documentationCategory
return string

filename public_oe property

public string filename
return string

fullDefinition public_oe property

public string fullDefinition
return string

groupSyntax public_oe property

If true, the generated documentation page should group the C++ syntax block with the other overloads of this function.
public bool groupSyntax
return bool

id public_oe property

public string id
return string

inbodyDescription public_oe property

public string inbodyDescription
return string

includes public_oe property

public List includes
return List

isConst public_oe property

public bool isConst
return bool

isExplicit public_oe property

public bool isExplicit
return bool

isMutable public_oe property

public bool isMutable
return bool

isStatic public_oe property

public bool isStatic
return bool

kind public_oe property

public string kind
return string

macroBody public_oe property

If kind == "define", then this symbol is a //#define macro, and this string contains the body of the macro.
public string macroBody
return string

name public_oe property

The name of the symbol this structure represents.
public string name
return string

notes public_oe property

public List notes
return List

otherOverloads public_oe property

This list specifies which other symbols use this symbol as the master doc page.
public List otherOverloads
return List

parameters public_oe property

If this Symbol is "function", this contains a list of all the parameters to the function.
public List parameters
return List

parent public_oe property

The symbol this symbol is contained in.
public Symbol,BindingsGenerator parent
return Symbol

path public_oe property

public string path
return string

returnComment public_oe property

Specifies the documentation for the @return field.
public string returnComment
return string

seeAlsoDocumentation public_oe property

public string seeAlsoDocumentation
return string

similarOverload public_oe property

If non-null, this member specifies an overload of this function that is shown in the doc webpage instead of this symbol. (This is to make the docs look shorter).
public Symbol,BindingsGenerator similarOverload
return Symbol

sourceFileEndLine public_oe property

public int sourceFileEndLine
return int

sourceFileStartLine public_oe property

public int sourceFileStartLine
return int

sourceFilename public_oe property

The code file where this symbol is defined.
public string sourceFilename
return string

todos public_oe property

public List todos
return List

type public_oe property

If this is a function, specifies the return value. If this is a member variable, specifies the variable type. If this is a class or a struct, this field is empty.
public string type
return string

value public_oe property

Enum initializer value. Null for others
public string value
return string

virtualness public_oe property

public Virtualness virtualness
return Virtualness

visibilityLevel public_oe property

public VisibilityLevel visibilityLevel
return VisibilityLevel