C# Class SDKDocGenerator.NDocUtilities

ファイルを表示 Open project: aws/aws-sdk-net Class Usage Examples

Public Methods

Method	Description
DetermineNDocNameLookupSignature ( MethodInfo info, string docId ) : string
DetermineNDocNameLookupSignature ( MethodInfoWrapper info ) : string
FindDocumentation ( AbstractWrapper wrapper ) : System.Xml.Linq.XElement
FindDocumentation ( XElement>.IDictionary ndoc, AbstractWrapper wrapper ) : System.Xml.Linq.XElement
FindDocumentation ( XElement>.IDictionary ndoc, ConstructorInfoWrapper info ) : System.Xml.Linq.XElement
FindDocumentation ( XElement>.IDictionary ndoc, EventInfoWrapper info ) : System.Xml.Linq.XElement
FindDocumentation ( XElement>.IDictionary ndoc, FieldInfoWrapper info ) : System.Xml.Linq.XElement
FindDocumentation ( XElement>.IDictionary ndoc, MethodInfoWrapper info ) : System.Xml.Linq.XElement
FindDocumentation ( XElement>.IDictionary ndoc, PropertyInfoWrapper info ) : System.Xml.Linq.XElement
FindDocumentation ( XElement>.IDictionary ndoc, TypeWrapper type ) : System.Xml.Linq.XElement
FindDocumentationPCLAsyncAlternative ( XElement>.IDictionary ndoc, MethodInfoWrapper info ) : System.Xml.Linq.XElement	For methods that DO NOT end in "Async", checks for the Async version of the method with a similar signature, following the PCL/.Net45 Async pattern.
FindDocumentationUnityAsync ( XElement>.IDictionary ndoc, MethodInfoWrapper info ) : System.Xml.Linq.XElement	For methods that end in "Async", checks for the method with a similar signature, but following the Unity Async pattern.
FindDocumentationUnityAsyncAlternative ( XElement>.IDictionary ndoc, MethodInfoWrapper info ) : System.Xml.Linq.XElement	For methods that DO NOT end in "Async", checks for the Async version of the method with a similar signature, following the Unity Async pattern.
FindFieldDocumentation ( XElement>.IDictionary ndoc, TypeWrapper type, string fieldName ) : System.Xml.Linq.XElement
FindFieldDocumentation ( TypeWrapper type, string fieldName ) : System.Xml.Linq.XElement
FindParameterDocumentation ( System.Xml.Linq.XElement ndoc, string name ) : string
FindReturnDocumentation ( System.Xml.Linq.XElement ndoc ) : string
GenerateDocId ( string serviceName, string platform ) : string
GetDocumentationInstance ( string docId ) : XElement>.IDictionary
GetDocumentationInstance ( string serviceName, string platform ) : XElement>.IDictionary
LoadAssemblyDocumentationWithSamples ( string filePath, string samplesDir, string serviceName ) : System.Xml.Linq.XDocument
LoadDocumentation ( string assemblyName, string serviceName, string platform, SDKDocGenerator.GeneratorOptions options ) : void
PreprocessCodeBlocksToPreTags ( SDKDocGenerator.GeneratorOptions options, System.Xml.Linq.XDocument doc ) : void
TransformDocumentationToHTML ( System.Xml.Linq.XElement element, string rootNodeName, AbstractTypeProvider typeProvider, SDKDocGenerator.FrameworkVersion version ) : string

Private Methods

Method	Description
BuildExamplesMap ( List docNodes ) : string>.IDictionary
CreateNDocTable ( string filePath, string serviceName, SDKDocGenerator.GeneratorOptions options ) : XElement>.IDictionary
DetermineParameterName ( TypeWrapper parameterTypeInfo, StringBuilder parameters ) : void
ExtractCrefAttributeContent ( string nodeText, int crefAttrStart, int &crossRefTagEndIndex ) : string
ExtractHrefAttributeContent ( string nodeText, int hrefAttrStart, int &crossRefTagEndIndex ) : string
FindFirstNoWhitePosition ( string line ) : int
FindSampleCodePath ( string codeSampleRootDirectory, string relativePath ) : string
LeftJustifyCodeBlocks ( string codeBlock ) : string
ProcessExtraDoc ( XmlDocument sdkDocument, string>.IDictionary examplesMap ) : void

Method Details

DetermineNDocNameLookupSignature() public static method

public static DetermineNDocNameLookupSignature ( MethodInfo info, string docId ) : string
info	System.Reflection.MethodInfo
docId	string
return	string

DetermineNDocNameLookupSignature() public static method

public static DetermineNDocNameLookupSignature ( MethodInfoWrapper info ) : string
info	MethodInfoWrapper
return	string

FindDocumentation() public static method

public static FindDocumentation ( AbstractWrapper wrapper ) : System.Xml.Linq.XElement
wrapper	AbstractWrapper
return	System.Xml.Linq.XElement

FindDocumentation() public static method

public static FindDocumentation ( XElement>.IDictionary ndoc, AbstractWrapper wrapper ) : System.Xml.Linq.XElement
ndoc	XElement>.IDictionary
wrapper	AbstractWrapper
return	System.Xml.Linq.XElement

FindDocumentation() public static method

public static FindDocumentation ( XElement>.IDictionary ndoc, ConstructorInfoWrapper info ) : System.Xml.Linq.XElement
ndoc	XElement>.IDictionary
info	ConstructorInfoWrapper
return	System.Xml.Linq.XElement

FindDocumentation() public static method

public static FindDocumentation ( XElement>.IDictionary ndoc, EventInfoWrapper info ) : System.Xml.Linq.XElement
ndoc	XElement>.IDictionary
info	EventInfoWrapper
return	System.Xml.Linq.XElement

FindDocumentation() public static method

public static FindDocumentation ( XElement>.IDictionary ndoc, FieldInfoWrapper info ) : System.Xml.Linq.XElement
ndoc	XElement>.IDictionary
info	FieldInfoWrapper
return	System.Xml.Linq.XElement

FindDocumentation() public static method

public static FindDocumentation ( XElement>.IDictionary ndoc, MethodInfoWrapper info ) : System.Xml.Linq.XElement
ndoc	XElement>.IDictionary
info	MethodInfoWrapper
return	System.Xml.Linq.XElement

FindDocumentation() public static method

public static FindDocumentation ( XElement>.IDictionary ndoc, PropertyInfoWrapper info ) : System.Xml.Linq.XElement
ndoc	XElement>.IDictionary
info	PropertyInfoWrapper
return	System.Xml.Linq.XElement

FindDocumentation() public static method

public static FindDocumentation ( XElement>.IDictionary ndoc, TypeWrapper type ) : System.Xml.Linq.XElement
ndoc	XElement>.IDictionary
type	TypeWrapper
return	System.Xml.Linq.XElement

FindDocumentationPCLAsyncAlternative() public static method

For methods that DO NOT end in "Async", checks for the Async version of the method with a similar signature, following the PCL/.Net45 Async pattern.

public static FindDocumentationPCLAsyncAlternative ( XElement>.IDictionary ndoc, MethodInfoWrapper info ) : System.Xml.Linq.XElement
ndoc	XElement>.IDictionary
info	MethodInfoWrapper
return	System.Xml.Linq.XElement

FindDocumentationUnityAsync() public static method

For methods that end in "Async", checks for the method with a similar signature, but following the Unity Async pattern.

public static FindDocumentationUnityAsync ( XElement>.IDictionary ndoc, MethodInfoWrapper info ) : System.Xml.Linq.XElement
ndoc	XElement>.IDictionary
info	MethodInfoWrapper
return	System.Xml.Linq.XElement

FindDocumentationUnityAsyncAlternative() public static method

For methods that DO NOT end in "Async", checks for the Async version of the method with a similar signature, following the Unity Async pattern.

public static FindDocumentationUnityAsyncAlternative ( XElement>.IDictionary ndoc, MethodInfoWrapper info ) : System.Xml.Linq.XElement
ndoc	XElement>.IDictionary
info	MethodInfoWrapper
return	System.Xml.Linq.XElement

FindFieldDocumentation() public static method

public static FindFieldDocumentation ( XElement>.IDictionary ndoc, TypeWrapper type, string fieldName ) : System.Xml.Linq.XElement
ndoc	XElement>.IDictionary
type	TypeWrapper
fieldName	string
return	System.Xml.Linq.XElement

FindFieldDocumentation() public static method

public static FindFieldDocumentation ( TypeWrapper type, string fieldName ) : System.Xml.Linq.XElement
type	TypeWrapper
fieldName	string
return	System.Xml.Linq.XElement

FindParameterDocumentation() public static method

public static FindParameterDocumentation ( System.Xml.Linq.XElement ndoc, string name ) : string
ndoc	System.Xml.Linq.XElement
name	string
return	string

FindReturnDocumentation() public static method

public static FindReturnDocumentation ( System.Xml.Linq.XElement ndoc ) : string
ndoc	System.Xml.Linq.XElement
return	string

GenerateDocId() public static method

public static GenerateDocId ( string serviceName, string platform ) : string
serviceName	string
platform	string
return	string

GetDocumentationInstance() public static method

public static GetDocumentationInstance ( string docId ) : XElement>.IDictionary
docId	string
return	XElement>.IDictionary

GetDocumentationInstance() public static method

public static GetDocumentationInstance ( string serviceName, string platform ) : XElement>.IDictionary
serviceName	string
platform	string
return	XElement>.IDictionary

LoadAssemblyDocumentationWithSamples() public static method

public static LoadAssemblyDocumentationWithSamples ( string filePath, string samplesDir, string serviceName ) : System.Xml.Linq.XDocument
filePath	string
samplesDir	string
serviceName	string
return	System.Xml.Linq.XDocument

LoadDocumentation() public static method

public static LoadDocumentation ( string assemblyName, string serviceName, string platform, SDKDocGenerator.GeneratorOptions options ) : void
assemblyName	string
serviceName	string
platform	string
options	SDKDocGenerator.GeneratorOptions
return	void

PreprocessCodeBlocksToPreTags() public static method

public static PreprocessCodeBlocksToPreTags ( SDKDocGenerator.GeneratorOptions options, System.Xml.Linq.XDocument doc ) : void
options	SDKDocGenerator.GeneratorOptions
doc	System.Xml.Linq.XDocument
return	void

TransformDocumentationToHTML() public static method

public static TransformDocumentationToHTML ( System.Xml.Linq.XElement element, string rootNodeName, AbstractTypeProvider typeProvider, SDKDocGenerator.FrameworkVersion version ) : string
element	System.Xml.Linq.XElement
rootNodeName	string
typeProvider	AbstractTypeProvider
version	SDKDocGenerator.FrameworkVersion
return	string