C# Class SDKDocGenerator.Writers.BaseWriter

Afficher le fichier Open project: aws/aws-sdk-net

Méthodes publiques

Свойство	Type	Description
BJSDisclaimerTemplate	string
FieldTableColumnHeaders	List
IconisedNameDescriptionTableColumnHeaders	List
NameDescriptionTableColumnHeaders	List
PropertiesTableColumnHeaders	List

Protected Properties

Свойство	Type	Description
_referAsyncAlternativePCL	bool
_referAsyncAlternativeUnity	bool
_unityVersionOfAsyncExists	bool
_version	FrameworkVersion

Méthodes publiques

Méthode	Description
CreateCrossReferenceTagReplacement ( AbstractTypeProvider typeProvider, string crefTypeName, FrameworkVersion version ) : string
GetCrossReferenceTypeName ( System.Xml.Linq.XElement element ) : string
Write ( ) : void
WriteCrossReferenceTagReplacement ( TextWriter writer, string typeName ) : void

Méthodes protégées

Méthode	Description
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

Private Methods

Méthode	Description
ComputeRelativePathToRoot ( string filePath ) : string
GenerateFeedbackHTML ( ) : string

Method Details

AddExamples() protected méthode

protected AddExamples ( TextWriter writer ) : void
writer	System.IO.TextWriter
Résultat	void

AddMemberTableSectionClosing() protected méthode

protected AddMemberTableSectionClosing ( TextWriter writer ) : void
writer	System.IO.TextWriter
Résultat	void

AddMemberTableSectionHeader() protected méthode

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
Résultat	void

AddMemberTableSectionHeader() protected méthode

protected AddMemberTableSectionHeader ( TextWriter writer, string name, bool showIconColumn = true ) : void
writer	System.IO.TextWriter
name	string
showIconColumn	bool
Résultat	void

AddNamespace() protected méthode

protected AddNamespace ( TextWriter writer, string ns, string moduleName ) : void
writer	System.IO.TextWriter
ns	string
moduleName	string
Résultat	void

AddRemarksDocumentation() protected méthode

protected AddRemarksDocumentation ( TextWriter writer ) : void
writer	System.IO.TextWriter
Résultat	void

AddSectionClosing() protected méthode

protected AddSectionClosing ( TextWriter writer ) : void
writer	System.IO.TextWriter
Résultat	void

AddSectionHeader() protected méthode

protected AddSectionHeader ( TextWriter writer, string name ) : void
writer	System.IO.TextWriter
name	string
Résultat	void

AddSummaryDocumentation() protected méthode

protected AddSummaryDocumentation ( TextWriter writer ) : void
writer	System.IO.TextWriter
Résultat	void

AddSummaryNotes() protected méthode

protected AddSummaryNotes ( TextWriter writer ) : void
writer	System.IO.TextWriter
Résultat	void

AddSyntax() protected méthode

protected AddSyntax ( TextWriter writer, string csharpSyntax ) : void
writer	System.IO.TextWriter
csharpSyntax	string
Résultat	void

AddVersionInformation() protected méthode

protected AddVersionInformation ( TextWriter writer, AbstractWrapper wrapper ) : void
writer	System.IO.TextWriter
wrapper	AbstractWrapper
Résultat	void

BaseWriter() protected méthode

protected BaseWriter ( GenerationManifest artifacts, AbstractTypeProvider typeProvider, FrameworkVersion version ) : System
artifacts	GenerationManifest
typeProvider	AbstractTypeProvider
version	FrameworkVersion
Résultat	System

BaseWriter() protected méthode

protected BaseWriter ( GenerationManifest artifacts, FrameworkVersion version ) : System
artifacts	GenerationManifest
version	FrameworkVersion
Résultat	System

CreateCrossReferenceTagReplacement() public static méthode

public static CreateCrossReferenceTagReplacement ( AbstractTypeProvider typeProvider, string crefTypeName, FrameworkVersion version ) : string
typeProvider	AbstractTypeProvider
crefTypeName	string
version	FrameworkVersion
Résultat	string

FormatParameters() protected méthode

protected FormatParameters ( IList infos ) : string
infos	IList
Résultat	string

GenerateFilename() protected abstract méthode

protected abstract GenerateFilename ( ) : string
Résultat	string

GenerateFilepath() protected abstract méthode

protected abstract GenerateFilepath ( ) : string
Résultat	string

GetCrossReferenceTypeName() public static méthode

public static GetCrossReferenceTypeName ( System.Xml.Linq.XElement element ) : string
element	System.Xml.Linq.XElement
Résultat	string

GetMemberName() protected abstract méthode

protected abstract GetMemberName ( ) : string
Résultat	string

GetMemberType() protected abstract méthode

protected abstract GetMemberType ( ) : string
Résultat	string

GetSummaryDocumentation() protected abstract méthode

protected abstract GetSummaryDocumentation ( ) : System.Xml.Linq.XElement
Résultat	System.Xml.Linq.XElement

GetTOCID() protected abstract méthode

protected abstract GetTOCID ( ) : string
Résultat	string

GetTitle() protected abstract méthode

protected abstract GetTitle ( ) : string
Résultat	string

Write() public méthode

public Write ( ) : void
Résultat	void

WriteContent() protected abstract méthode

protected abstract WriteContent ( TextWriter writer ) : void
writer	System.IO.TextWriter
Résultat	void

WriteCrossReferenceTagReplacement() public méthode

public WriteCrossReferenceTagReplacement ( TextWriter writer, string typeName ) : void
writer	System.IO.TextWriter
typeName	string
Résultat	void

WriteFooter() protected méthode

protected WriteFooter ( TextWriter writer ) : void
writer	System.IO.TextWriter
Résultat	void

WriteHeader() protected méthode

protected WriteHeader ( TextWriter writer ) : void
writer	System.IO.TextWriter
Résultat	void

WriteRegionDisclaimer() protected méthode

protected WriteRegionDisclaimer ( TextWriter writer ) : void
writer	System.IO.TextWriter
Résultat	void

WriteScriptFiles() protected méthode

protected WriteScriptFiles ( TextWriter writer ) : void
writer	System.IO.TextWriter
Résultat	void

WriteToolbar() protected méthode

protected WriteToolbar ( TextWriter writer ) : void
writer	TextWriter
Résultat	void

Property Details

BJSDisclaimerTemplate public_oe static_oe property

public static string BJSDisclaimerTemplate
Résultat	string

FieldTableColumnHeaders public_oe static_oe property

public static List FieldTableColumnHeaders
Résultat	List

IconisedNameDescriptionTableColumnHeaders public_oe static_oe property

public static List IconisedNameDescriptionTableColumnHeaders
Résultat	List

NameDescriptionTableColumnHeaders public_oe static_oe property

public static List NameDescriptionTableColumnHeaders
Résultat	List

PropertiesTableColumnHeaders public_oe static_oe property

public static List PropertiesTableColumnHeaders
Résultat	List

_referAsyncAlternativePCL protected_oe property

protected bool _referAsyncAlternativePCL
Résultat	bool

_referAsyncAlternativeUnity protected_oe property

protected bool _referAsyncAlternativeUnity
Résultat	bool

_unityVersionOfAsyncExists protected_oe property

protected bool _unityVersionOfAsyncExists
Résultat	bool

_version protected_oe property

protected FrameworkVersion _version
Résultat	FrameworkVersion