• Home
• IronPython
• Runtime
• Types
• DocBuilder

C# Class IronPython.Runtime.Types.DocBuilder

显示文件 Open project: jschementi/iron Class Usage Examples

Public Methods

Method	Description
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.

Private Methods

Method	Description
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.

Method Details