C# Class SDKDocGenerator.Writers.BaseWriter

Mostra file Open project: aws/aws-sdk-net

Public Properties

Property	Type	Description
BJSDisclaimerTemplate	string
FieldTableColumnHeaders	List
IconisedNameDescriptionTableColumnHeaders	List
NameDescriptionTableColumnHeaders	List
PropertiesTableColumnHeaders	List

Protected Properties

Property	Type	Description
_referAsyncAlternativePCL	bool
_referAsyncAlternativeUnity	bool
_unityVersionOfAsyncExists	bool
_version	FrameworkVersion

Public Methods

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

Protected Methods

Method	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

Method	Description
ComputeRelativePathToRoot ( string filePath ) : string
GenerateFeedbackHTML ( ) : string

Method Details

AddExamples() protected method

protected AddExamples ( TextWriter writer ) : void
writer	System.IO.TextWriter
return	void

AddMemberTableSectionClosing() protected method

protected AddMemberTableSectionClosing ( TextWriter writer ) : void
writer	System.IO.TextWriter
return	void

AddMemberTableSectionHeader() protected method

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
return	void

AddMemberTableSectionHeader() protected method

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

AddNamespace() protected method

protected AddNamespace ( TextWriter writer, string ns, string moduleName ) : void
writer	System.IO.TextWriter
ns	string
moduleName	string
return	void

AddRemarksDocumentation() protected method

protected AddRemarksDocumentation ( TextWriter writer ) : void
writer	System.IO.TextWriter
return	void

AddSectionClosing() protected method

protected AddSectionClosing ( TextWriter writer ) : void
writer	System.IO.TextWriter
return	void

AddSectionHeader() protected method

protected AddSectionHeader ( TextWriter writer, string name ) : void
writer	System.IO.TextWriter
name	string
return	void

AddSummaryDocumentation() protected method

protected AddSummaryDocumentation ( TextWriter writer ) : void
writer	System.IO.TextWriter
return	void

AddSummaryNotes() protected method

protected AddSummaryNotes ( TextWriter writer ) : void
writer	System.IO.TextWriter
return	void

AddSyntax() protected method

protected AddSyntax ( TextWriter writer, string csharpSyntax ) : void
writer	System.IO.TextWriter
csharpSyntax	string
return	void

AddVersionInformation() protected method

protected AddVersionInformation ( TextWriter writer, AbstractWrapper wrapper ) : void
writer	System.IO.TextWriter
wrapper	AbstractWrapper
return	void

BaseWriter() protected method

protected BaseWriter ( GenerationManifest artifacts, AbstractTypeProvider typeProvider, FrameworkVersion version ) : System
artifacts	GenerationManifest
typeProvider	AbstractTypeProvider
version	FrameworkVersion
return	System

BaseWriter() protected method

protected BaseWriter ( GenerationManifest artifacts, FrameworkVersion version ) : System
artifacts	GenerationManifest
version	FrameworkVersion
return	System

CreateCrossReferenceTagReplacement() public static method

public static CreateCrossReferenceTagReplacement ( AbstractTypeProvider typeProvider, string crefTypeName, FrameworkVersion version ) : string
typeProvider	AbstractTypeProvider
crefTypeName	string
version	FrameworkVersion
return	string

FormatParameters() protected method

protected FormatParameters ( IList infos ) : string
infos	IList
return	string

GenerateFilename() protected abstract method

protected abstract GenerateFilename ( ) : string
return	string

GenerateFilepath() protected abstract method

protected abstract GenerateFilepath ( ) : string
return	string

GetCrossReferenceTypeName() public static method

public static GetCrossReferenceTypeName ( System.Xml.Linq.XElement element ) : string
element	System.Xml.Linq.XElement
return	string

GetMemberName() protected abstract method

protected abstract GetMemberName ( ) : string
return	string

GetMemberType() protected abstract method

protected abstract GetMemberType ( ) : string
return	string

GetSummaryDocumentation() protected abstract method

protected abstract GetSummaryDocumentation ( ) : System.Xml.Linq.XElement
return	System.Xml.Linq.XElement

GetTOCID() protected abstract method

protected abstract GetTOCID ( ) : string
return	string

GetTitle() protected abstract method

protected abstract GetTitle ( ) : string
return	string

Write() public method

public Write ( ) : void
return	void

WriteContent() protected abstract method

protected abstract WriteContent ( TextWriter writer ) : void
writer	System.IO.TextWriter
return	void

WriteCrossReferenceTagReplacement() public method

public WriteCrossReferenceTagReplacement ( TextWriter writer, string typeName ) : void
writer	System.IO.TextWriter
typeName	string
return	void

WriteFooter() protected method

protected WriteFooter ( TextWriter writer ) : void
writer	System.IO.TextWriter
return	void

WriteHeader() protected method

protected WriteHeader ( TextWriter writer ) : void
writer	System.IO.TextWriter
return	void

WriteRegionDisclaimer() protected method

protected WriteRegionDisclaimer ( TextWriter writer ) : void
writer	System.IO.TextWriter
return	void

WriteScriptFiles() protected method

protected WriteScriptFiles ( TextWriter writer ) : void
writer	System.IO.TextWriter
return	void

WriteToolbar() protected method

protected WriteToolbar ( TextWriter writer ) : void
writer	TextWriter
return	void

Property Details

BJSDisclaimerTemplate public_oe static_oe property

public static string BJSDisclaimerTemplate
return	string

FieldTableColumnHeaders public_oe static_oe property

public static List FieldTableColumnHeaders
return	List

IconisedNameDescriptionTableColumnHeaders public_oe static_oe property

public static List IconisedNameDescriptionTableColumnHeaders
return	List

NameDescriptionTableColumnHeaders public_oe static_oe property

public static List NameDescriptionTableColumnHeaders
return	List

PropertiesTableColumnHeaders public_oe static_oe property

public static List PropertiesTableColumnHeaders
return	List

_referAsyncAlternativePCL protected_oe property

protected bool _referAsyncAlternativePCL
return	bool

_referAsyncAlternativeUnity protected_oe property

protected bool _referAsyncAlternativeUnity
return	bool

_unityVersionOfAsyncExists protected_oe property

protected bool _unityVersionOfAsyncExists
return	bool

_version protected_oe property

protected FrameworkVersion _version
return	FrameworkVersion