C# Class BindingsGenerator.Symbol

Afficher le fichier Open project: realXtend/tundra-urho3d Class Usage Examples

Méthodes publiques

Свойство 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

Méthodes publiques

Méthode 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

Méthode Description
EscapeFilename ( string s ) : string

Method Details

ArgStringWithoutTypes() public méthode

public ArgStringWithoutTypes ( ) : string
Résultat string

ArrayLength() public méthode

public ArrayLength ( ) : int
Résultat int

BriefComment() public méthode

public BriefComment ( ) : string
Résultat string

Category() public méthode

public Category ( ) : string
Résultat string

ClassCtor() public méthode

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
Résultat Symbol

ClassIndexDocFilename() public méthode

public ClassIndexDocFilename ( ) : string
Résultat string

Comments() public méthode

public Comments ( ) : string[]
Résultat string[]

FindChildByName() public méthode

public FindChildByName ( string name ) : Symbol
name string
Résultat Symbol

FindParamByName() public méthode

public FindParamByName ( string paramName ) : Parameter
paramName string
Résultat Parameter

FullQualifiedSymbolName() public méthode

public FullQualifiedSymbolName ( ) : string
Résultat string

FullQualifiedSymbolNameWithoutNamespace() public méthode

public FullQualifiedSymbolNameWithoutNamespace ( ) : string
Résultat string

IsArray() public méthode

public IsArray ( ) : bool
Résultat bool

IsConst() public méthode

public IsConst ( ) : bool
Résultat bool

IsNumberType() public static méthode

public static IsNumberType ( string type ) : bool
type string
Résultat bool

IsPODType() public static méthode

public static IsPODType ( string type ) : bool
type string
Résultat bool

MemberDocumentationFilename() public méthode

public MemberDocumentationFilename ( ) : string
Résultat string

MemberDocumentationFilenameWithoutFileSuffix() public méthode

public MemberDocumentationFilenameWithoutFileSuffix ( ) : string
Résultat string

NameWithoutNamespace() public méthode

public NameWithoutNamespace ( ) : string
Résultat string

Namespace() public méthode

public Namespace ( ) : string
Résultat string

ScopeName() public méthode

public ScopeName ( ) : string
Résultat string

ScopeNameWithoutNamespace() public méthode

public ScopeNameWithoutNamespace ( ) : string
Résultat string

Property Details

argList public_oe property

public string argList
Résultat string

author public_oe property

public string author
Résultat 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
Résultat List

briefDescription public_oe property

public string briefDescription
Résultat string

bugs public_oe property

public List bugs
Résultat List

children public_oe property

public List children
Résultat 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
Résultat string

detailedDescription public_oe property

public string detailedDescription
Résultat string

documentationCategory public_oe property

public string documentationCategory
Résultat string

filename public_oe property

public string filename
Résultat string

fullDefinition public_oe property

public string fullDefinition
Résultat 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
Résultat bool

id public_oe property

public string id
Résultat string

inbodyDescription public_oe property

public string inbodyDescription
Résultat string

includes public_oe property

public List includes
Résultat List

isConst public_oe property

public bool isConst
Résultat bool

isExplicit public_oe property

public bool isExplicit
Résultat bool

isMutable public_oe property

public bool isMutable
Résultat bool

isStatic public_oe property

public bool isStatic
Résultat bool

kind public_oe property

public string kind
Résultat 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
Résultat string

name public_oe property

The name of the symbol this structure represents.
public string name
Résultat string

notes public_oe property

public List notes
Résultat List

otherOverloads public_oe property

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

parameters public_oe property

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

parent public_oe property

The symbol this symbol is contained in.
public Symbol,BindingsGenerator parent
Résultat Symbol

path public_oe property

public string path
Résultat string

returnComment public_oe property

Specifies the documentation for the @return field.
public string returnComment
Résultat string

seeAlsoDocumentation public_oe property

public string seeAlsoDocumentation
Résultat 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
Résultat Symbol

sourceFileEndLine public_oe property

public int sourceFileEndLine
Résultat int

sourceFileStartLine public_oe property

public int sourceFileStartLine
Résultat int

sourceFilename public_oe property

The code file where this symbol is defined.
public string sourceFilename
Résultat string

todos public_oe property

public List todos
Résultat 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
Résultat string

value public_oe property

Enum initializer value. Null for others
public string value
Résultat string

virtualness public_oe property

public Virtualness virtualness
Résultat Virtualness

visibilityLevel public_oe property

public VisibilityLevel visibilityLevel
Résultat VisibilityLevel