C# Класс SDKDocGenerator.Writers.BaseWriter

Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
BJSDisclaimerTemplate string
FieldTableColumnHeaders List
IconisedNameDescriptionTableColumnHeaders List
NameDescriptionTableColumnHeaders List
PropertiesTableColumnHeaders List

Защищенные свойства (Protected)

Свойство Тип Описание
_referAsyncAlternativePCL bool
_referAsyncAlternativeUnity bool
_unityVersionOfAsyncExists bool
_version FrameworkVersion

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

Метод Описание
CreateCrossReferenceTagReplacement ( AbstractTypeProvider typeProvider, string crefTypeName, FrameworkVersion version ) : string
GetCrossReferenceTypeName ( System.Xml.Linq.XElement element ) : string
Write ( ) : void
WriteCrossReferenceTagReplacement ( TextWriter writer, string typeName ) : void

Защищенные методы

Метод Описание
AddExamples ( TextWriter writer ) : void
AddMemberTableSectionClosing ( TextWriter writer ) : void
AddMemberTableSectionHeader ( TextWriter writer, string title, List columnHeaders ) : void

Adds a standard member-name/description table with optional type column
AddMemberTableSectionHeader ( TextWriter writer, string name, bool showIconColumn = true ) : void
AddNamespace ( TextWriter writer, string ns, string moduleName ) : void
AddRemarksDocumentation ( TextWriter writer ) : void
AddSectionClosing ( TextWriter writer ) : void
AddSectionHeader ( TextWriter writer, string name ) : void
AddSummaryDocumentation ( TextWriter writer ) : void
AddSummaryNotes ( TextWriter writer ) : void
AddSyntax ( TextWriter writer, string csharpSyntax ) : void
AddVersionInformation ( TextWriter writer, AbstractWrapper wrapper ) : void
BaseWriter ( GenerationManifest artifacts, AbstractTypeProvider typeProvider, FrameworkVersion version ) : System
BaseWriter ( GenerationManifest artifacts, FrameworkVersion version ) : System
FormatParameters ( IList infos ) : string
GenerateFilename ( ) : string
GenerateFilepath ( ) : string
GetMemberName ( ) : string
GetMemberType ( ) : string
GetSummaryDocumentation ( ) : System.Xml.Linq.XElement
GetTOCID ( ) : string
GetTitle ( ) : string
WriteContent ( TextWriter writer ) : void
WriteFooter ( TextWriter writer ) : void
WriteHeader ( TextWriter writer ) : void
WriteRegionDisclaimer ( TextWriter writer ) : void
WriteScriptFiles ( TextWriter writer ) : void
WriteToolbar ( TextWriter writer ) : void

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

Метод Описание
ComputeRelativePathToRoot ( string filePath ) : string
GenerateFeedbackHTML ( ) : string

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

AddExamples() защищенный Метод

protected AddExamples ( TextWriter writer ) : void
writer System.IO.TextWriter
Результат void

AddMemberTableSectionClosing() защищенный Метод

protected AddMemberTableSectionClosing ( TextWriter writer ) : void
writer System.IO.TextWriter
Результат void

AddMemberTableSectionHeader() защищенный Метод

Adds a standard member-name/description table with optional type column
protected AddMemberTableSectionHeader ( TextWriter writer, string title, List columnHeaders ) : void
writer System.IO.TextWriter
title string
columnHeaders List
Результат void

AddMemberTableSectionHeader() защищенный Метод

protected AddMemberTableSectionHeader ( TextWriter writer, string name, bool showIconColumn = true ) : void
writer System.IO.TextWriter
name string
showIconColumn bool
Результат void

AddNamespace() защищенный Метод

protected AddNamespace ( TextWriter writer, string ns, string moduleName ) : void
writer System.IO.TextWriter
ns string
moduleName string
Результат void

AddRemarksDocumentation() защищенный Метод

protected AddRemarksDocumentation ( TextWriter writer ) : void
writer System.IO.TextWriter
Результат void

AddSectionClosing() защищенный Метод

protected AddSectionClosing ( TextWriter writer ) : void
writer System.IO.TextWriter
Результат void

AddSectionHeader() защищенный Метод

protected AddSectionHeader ( TextWriter writer, string name ) : void
writer System.IO.TextWriter
name string
Результат void

AddSummaryDocumentation() защищенный Метод

protected AddSummaryDocumentation ( TextWriter writer ) : void
writer System.IO.TextWriter
Результат void

AddSummaryNotes() защищенный Метод

protected AddSummaryNotes ( TextWriter writer ) : void
writer System.IO.TextWriter
Результат void

AddSyntax() защищенный Метод

protected AddSyntax ( TextWriter writer, string csharpSyntax ) : void
writer System.IO.TextWriter
csharpSyntax string
Результат void

AddVersionInformation() защищенный Метод

protected AddVersionInformation ( TextWriter writer, AbstractWrapper wrapper ) : void
writer System.IO.TextWriter
wrapper AbstractWrapper
Результат void

BaseWriter() защищенный Метод

protected BaseWriter ( GenerationManifest artifacts, AbstractTypeProvider typeProvider, FrameworkVersion version ) : System
artifacts GenerationManifest
typeProvider AbstractTypeProvider
version FrameworkVersion
Результат System

BaseWriter() защищенный Метод

protected BaseWriter ( GenerationManifest artifacts, FrameworkVersion version ) : System
artifacts GenerationManifest
version FrameworkVersion
Результат System

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

public static CreateCrossReferenceTagReplacement ( AbstractTypeProvider typeProvider, string crefTypeName, FrameworkVersion version ) : string
typeProvider AbstractTypeProvider
crefTypeName string
version FrameworkVersion
Результат string

FormatParameters() защищенный Метод

protected FormatParameters ( IList infos ) : string
infos IList
Результат string

GenerateFilename() защищенный абстрактный Метод

protected abstract GenerateFilename ( ) : string
Результат string

GenerateFilepath() защищенный абстрактный Метод

protected abstract GenerateFilepath ( ) : string
Результат string

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

public static GetCrossReferenceTypeName ( System.Xml.Linq.XElement element ) : string
element System.Xml.Linq.XElement
Результат string

GetMemberName() защищенный абстрактный Метод

protected abstract GetMemberName ( ) : string
Результат string

GetMemberType() защищенный абстрактный Метод

protected abstract GetMemberType ( ) : string
Результат string

GetSummaryDocumentation() защищенный абстрактный Метод

protected abstract GetSummaryDocumentation ( ) : System.Xml.Linq.XElement
Результат System.Xml.Linq.XElement

GetTOCID() защищенный абстрактный Метод

protected abstract GetTOCID ( ) : string
Результат string

GetTitle() защищенный абстрактный Метод

protected abstract GetTitle ( ) : string
Результат string

Write() публичный Метод

public Write ( ) : void
Результат void

WriteContent() защищенный абстрактный Метод

protected abstract WriteContent ( TextWriter writer ) : void
writer System.IO.TextWriter
Результат void

WriteCrossReferenceTagReplacement() публичный Метод

public WriteCrossReferenceTagReplacement ( TextWriter writer, string typeName ) : void
writer System.IO.TextWriter
typeName string
Результат void

WriteFooter() защищенный Метод

protected WriteFooter ( TextWriter writer ) : void
writer System.IO.TextWriter
Результат void

WriteHeader() защищенный Метод

protected WriteHeader ( TextWriter writer ) : void
writer System.IO.TextWriter
Результат void

WriteRegionDisclaimer() защищенный Метод

protected WriteRegionDisclaimer ( TextWriter writer ) : void
writer System.IO.TextWriter
Результат void

WriteScriptFiles() защищенный Метод

protected WriteScriptFiles ( TextWriter writer ) : void
writer System.IO.TextWriter
Результат void

WriteToolbar() защищенный Метод

protected WriteToolbar ( TextWriter writer ) : void
writer TextWriter
Результат void

Описание свойств

BJSDisclaimerTemplate публичное статическое свойство

public static string BJSDisclaimerTemplate
Результат string

FieldTableColumnHeaders публичное статическое свойство

public static List FieldTableColumnHeaders
Результат List

IconisedNameDescriptionTableColumnHeaders публичное статическое свойство

public static List IconisedNameDescriptionTableColumnHeaders
Результат List

NameDescriptionTableColumnHeaders публичное статическое свойство

public static List NameDescriptionTableColumnHeaders
Результат List

PropertiesTableColumnHeaders публичное статическое свойство

public static List PropertiesTableColumnHeaders
Результат List

_referAsyncAlternativePCL защищенное свойство

protected bool _referAsyncAlternativePCL
Результат bool

_referAsyncAlternativeUnity защищенное свойство

protected bool _referAsyncAlternativeUnity
Результат bool

_unityVersionOfAsyncExists защищенное свойство

protected bool _unityVersionOfAsyncExists
Результат bool

_version защищенное свойство

protected FrameworkVersion _version
Результат FrameworkVersion