C# 클래스 SDKDocGenerator.NDocUtilities

파일 보기 프로젝트 열기: aws/aws-sdk-net 1 사용 예제들

공개 메소드들

메소드 설명
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

비공개 메소드들

메소드 설명
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

메소드 상세

DetermineNDocNameLookupSignature() 공개 정적인 메소드

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

DetermineNDocNameLookupSignature() 공개 정적인 메소드

public static DetermineNDocNameLookupSignature ( MethodInfoWrapper info ) : string
info MethodInfoWrapper
리턴 string

FindDocumentation() 공개 정적인 메소드

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

FindDocumentation() 공개 정적인 메소드

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

FindDocumentation() 공개 정적인 메소드

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

FindDocumentation() 공개 정적인 메소드

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

FindDocumentation() 공개 정적인 메소드

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

FindDocumentation() 공개 정적인 메소드

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

FindDocumentation() 공개 정적인 메소드

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

FindDocumentation() 공개 정적인 메소드

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

FindDocumentationPCLAsyncAlternative() 공개 정적인 메소드

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
리턴 System.Xml.Linq.XElement

FindDocumentationUnityAsync() 공개 정적인 메소드

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
리턴 System.Xml.Linq.XElement

FindDocumentationUnityAsyncAlternative() 공개 정적인 메소드

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
리턴 System.Xml.Linq.XElement

FindFieldDocumentation() 공개 정적인 메소드

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

FindFieldDocumentation() 공개 정적인 메소드

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

FindParameterDocumentation() 공개 정적인 메소드

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

FindReturnDocumentation() 공개 정적인 메소드

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

GenerateDocId() 공개 정적인 메소드

public static GenerateDocId ( string serviceName, string platform ) : string
serviceName string
platform string
리턴 string

GetDocumentationInstance() 공개 정적인 메소드

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

GetDocumentationInstance() 공개 정적인 메소드

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

LoadAssemblyDocumentationWithSamples() 공개 정적인 메소드

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

LoadDocumentation() 공개 정적인 메소드

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

PreprocessCodeBlocksToPreTags() 공개 정적인 메소드

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

TransformDocumentationToHTML() 공개 정적인 메소드

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
리턴 string