• Главная
• SDKDocGenerator
• NDocUtilities

C# Класс SDKDocGenerator.NDocUtilities

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

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

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

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