C# Класс BindingsGenerator.Symbol

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
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

Открытые методы

Метод Описание
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

Приватные методы

Метод Описание
EscapeFilename ( string s ) : string

Описание методов

ArgStringWithoutTypes() публичный Метод

public ArgStringWithoutTypes ( ) : string
Результат string

ArrayLength() публичный Метод

public ArrayLength ( ) : int
Результат int

BriefComment() публичный Метод

public BriefComment ( ) : string
Результат string

Category() публичный Метод

public Category ( ) : string
Результат string

ClassCtor() публичный Метод

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
Результат Symbol

ClassIndexDocFilename() публичный Метод

public ClassIndexDocFilename ( ) : string
Результат string

Comments() публичный Метод

public Comments ( ) : string[]
Результат string[]

FindChildByName() публичный Метод

public FindChildByName ( string name ) : Symbol
name string
Результат Symbol

FindParamByName() публичный Метод

public FindParamByName ( string paramName ) : Parameter
paramName string
Результат Parameter

FullQualifiedSymbolName() публичный Метод

public FullQualifiedSymbolName ( ) : string
Результат string

FullQualifiedSymbolNameWithoutNamespace() публичный Метод

public FullQualifiedSymbolNameWithoutNamespace ( ) : string
Результат string

IsArray() публичный Метод

public IsArray ( ) : bool
Результат bool

IsConst() публичный Метод

public IsConst ( ) : bool
Результат bool

IsNumberType() публичный статический Метод

public static IsNumberType ( string type ) : bool
type string
Результат bool

IsPODType() публичный статический Метод

public static IsPODType ( string type ) : bool
type string
Результат bool

MemberDocumentationFilename() публичный Метод

public MemberDocumentationFilename ( ) : string
Результат string

MemberDocumentationFilenameWithoutFileSuffix() публичный Метод

public MemberDocumentationFilenameWithoutFileSuffix ( ) : string
Результат string

NameWithoutNamespace() публичный Метод

public NameWithoutNamespace ( ) : string
Результат string

Namespace() публичный Метод

public Namespace ( ) : string
Результат string

ScopeName() публичный Метод

public ScopeName ( ) : string
Результат string

ScopeNameWithoutNamespace() публичный Метод

public ScopeNameWithoutNamespace ( ) : string
Результат string

Описание свойств

argList публичное свойство

public string argList
Результат string

author публичное свойство

public string author
Результат string

baseClasses публичное свойство

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
Результат List

briefDescription публичное свойство

public string briefDescription
Результат string

bugs публичное свойство

public List bugs
Результат List

children публичное свойство

public List children
Результат List

classMemberIndexTitle публичное свойство

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
Результат string

detailedDescription публичное свойство

public string detailedDescription
Результат string

documentationCategory публичное свойство

public string documentationCategory
Результат string

filename публичное свойство

public string filename
Результат string

fullDefinition публичное свойство

public string fullDefinition
Результат string

groupSyntax публичное свойство

If true, the generated documentation page should group the C++ syntax block with the other overloads of this function.
public bool groupSyntax
Результат bool

id публичное свойство

public string id
Результат string

inbodyDescription публичное свойство

public string inbodyDescription
Результат string

includes публичное свойство

public List includes
Результат List

isConst публичное свойство

public bool isConst
Результат bool

isExplicit публичное свойство

public bool isExplicit
Результат bool

isMutable публичное свойство

public bool isMutable
Результат bool

isStatic публичное свойство

public bool isStatic
Результат bool

kind публичное свойство

public string kind
Результат string

macroBody публичное свойство

If kind == "define", then this symbol is a //#define macro, and this string contains the body of the macro.
public string macroBody
Результат string

name публичное свойство

The name of the symbol this structure represents.
public string name
Результат string

notes публичное свойство

public List notes
Результат List

otherOverloads публичное свойство

This list specifies which other symbols use this symbol as the master doc page.
public List otherOverloads
Результат List

parameters публичное свойство

If this Symbol is "function", this contains a list of all the parameters to the function.
public List parameters
Результат List

parent публичное свойство

The symbol this symbol is contained in.
public Symbol,BindingsGenerator parent
Результат Symbol

path публичное свойство

public string path
Результат string

returnComment публичное свойство

Specifies the documentation for the @return field.
public string returnComment
Результат string

seeAlsoDocumentation публичное свойство

public string seeAlsoDocumentation
Результат string

similarOverload публичное свойство

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
Результат Symbol

sourceFileEndLine публичное свойство

public int sourceFileEndLine
Результат int

sourceFileStartLine публичное свойство

public int sourceFileStartLine
Результат int

sourceFilename публичное свойство

The code file where this symbol is defined.
public string sourceFilename
Результат string

todos публичное свойство

public List todos
Результат List

type публичное свойство

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
Результат string

value публичное свойство

Enum initializer value. Null for others
public string value
Результат string

virtualness публичное свойство

public Virtualness virtualness
Результат Virtualness

visibilityLevel публичное свойство

public VisibilityLevel visibilityLevel
Результат VisibilityLevel