C# Класс IronPython.Runtime.Types.DocBuilder

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

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

Метод	Описание
CreateAutoDoc ( EventInfo info ) : string
CreateAutoDoc ( MethodBase info ) : string
CreateAutoDoc ( Type t ) : string
DocOneInfo ( ExtensionPropertyInfo info ) : string
DocOneInfo ( FieldInfo info ) : string
DocOneInfo ( MethodBase info, string name ) : string
DocOneInfo ( MethodBase info, string name, bool includeSelf ) : string
DocOneInfo ( PropertyInfo info ) : string
GetOverloadDoc ( MethodBase info, string name, int endParamSkip ) : Microsoft.Scripting.Hosting.OverloadDoc
GetOverloadDoc ( MethodBase info, string name, int endParamSkip, bool includeSelf ) : Microsoft.Scripting.Hosting.OverloadDoc	Creates a DLR OverloadDoc object which describes information about this overload.

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

Метод	Описание
AppendTypeFormat ( Type curType, StringBuilder res ) : void	Converts a Type object into a string suitable for lookup in the help file. All generic types are converted down to their generic type definition.
CreateAutoDoc ( MethodBase info, string name, int endParamSkip ) : string
CreateAutoDoc ( MethodBase info, string name, int endParamSkip, bool includeSelf ) : string
DocOneInfoForProperty ( Type declaringType, string propertyName, MethodInfo getter, MethodInfo setter, object attrs ) : string
GetDefaultDocumentation ( string methodName ) : string
GetPythonTypeName ( Type type ) : string
GetXPathDocument ( Assembly asm ) : XPathDocument	Gets the XPathDocument for the specified assembly, or null if one is not available.
GetXmlDoc ( EventInfo info, string &summary, string &returns ) : void	Gets the Xml documentation for the specified Field.
GetXmlDoc ( MethodBase info, string &summary, string &returns, string>.List &parameters ) : void	Gets the Xml documentation for the specified MethodBase.
GetXmlDoc ( Type type, string &summary ) : void	Gets the Xml documentation for the specified Type.
GetXmlDocForProperty ( Type declaringType, string propertyName, string &summary, string &returns ) : void	Gets the Xml documentation for the specified Field.
GetXmlDocLocation ( Assembly assem ) : string
GetXmlName ( EventInfo field ) : string
GetXmlName ( MethodBase info ) : string
GetXmlName ( Type type ) : string
GetXmlNameForProperty ( Type declaringType, string propertyName ) : string
XmlToString ( XPathNodeIterator iter ) : string	Converts the XML as stored in the config file into a human readable string.

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

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

public static CreateAutoDoc ( EventInfo info ) : string
info	System.Reflection.EventInfo
Результат	string

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

public static CreateAutoDoc ( MethodBase info ) : string
info	System.Reflection.MethodBase
Результат	string

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

public static CreateAutoDoc ( Type t ) : string
t	System.Type
Результат	string

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

public static DocOneInfo ( ExtensionPropertyInfo info ) : string
info	ExtensionPropertyInfo
Результат	string

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

public static DocOneInfo ( FieldInfo info ) : string
info	System.Reflection.FieldInfo
Результат	string

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

public static DocOneInfo ( MethodBase info, string name ) : string
info	System.Reflection.MethodBase
name	string
Результат	string

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

public static DocOneInfo ( MethodBase info, string name, bool includeSelf ) : string
info	System.Reflection.MethodBase
name	string
includeSelf	bool
Результат	string

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

public static DocOneInfo ( PropertyInfo info ) : string
info	System.Reflection.PropertyInfo
Результат	string

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

public static GetOverloadDoc ( MethodBase info, string name, int endParamSkip ) : Microsoft.Scripting.Hosting.OverloadDoc
info	System.Reflection.MethodBase
name	string
endParamSkip	int
Результат	Microsoft.Scripting.Hosting.OverloadDoc

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

Creates a DLR OverloadDoc object which describes information about this overload.

public static GetOverloadDoc ( MethodBase info, string name, int endParamSkip, bool includeSelf ) : Microsoft.Scripting.Hosting.OverloadDoc
info	System.Reflection.MethodBase	The method to document
name	string	The name of the method if it should override the name in the MethodBase
endParamSkip	int	Parameters to skip at the end - used for removing the value on a setter method
includeSelf	bool	true to include self on instance methods
Результат	Microsoft.Scripting.Hosting.OverloadDoc