C# Class SDKDocGenerator.GenerationManifest

Wraps the generation information required to emit documentation for a service, which may have assemblies in all or some of the platforms subfolders.

Mostra file Open project: aws/aws-sdk-net Class Usage Examples

Public Methods

Method	Description
Generate ( IEnumerable ignoreNamespaces ) : void	Generates the documentation for the artifacts represented by this manifest, starting at the namespace(s) in the assembly and working down through the type hierarchy.
GenerationManifest ( string assemblyPath, string outputFolderRoot, IEnumerable allPlatforms, SDKDocGenerator.GeneratorOptions options, bool useAppDomain ) : System	Represents a single service, supported on one or more platforms, that we will be generating documentation for.
NDocForPlatform ( string platform = null ) : XElement>.IDictionary	Returns the discovered NDoc table for a given platform, if it existed. If platform is not specified, we attempt to return the NDoc for the primary platform specified in the generator options.
OutputSubFolderFromNamespace ( string ns ) : string	Returns the subfolder name that should be used for Amazon artifacts belonging to the specified namespace. Typically we use the service root level (the second part) in the namespace. If the namespace is not recognized as belonging to Amazon, an empty string is returned.
WriteNamespace ( SDKDocGenerator.FrameworkVersion version, string namespaceName ) : void
WriteType ( SDKDocGenerator.FrameworkVersion version, TypeWrapper type ) : void

Private Methods

Method	Description
CreateAssemblyWrapper ( string filePath, bool useAppDomain ) : AssemblyWrapper

Method Details

Generate() public method

Generates the documentation for the artifacts represented by this manifest, starting at the namespace(s) in the assembly and working down through the type hierarchy.

public Generate ( IEnumerable ignoreNamespaces ) : void
ignoreNamespaces	IEnumerable
return	void

GenerationManifest() public method

Represents a single service, supported on one or more platforms, that we will be generating documentation for.

public GenerationManifest ( string assemblyPath, string outputFolderRoot, IEnumerable allPlatforms, SDKDocGenerator.GeneratorOptions options, bool useAppDomain ) : System
assemblyPath	string	/// The full path and filename of the assembly. The .Net platform for the assembly /// is assumed to be the name of the folder containing the assembly. The name of the /// service will be inferred from the name pattern of the assembly. ///
outputFolderRoot	string	/// The root output folder that the artifacts should be placed in. A further subfolder /// representing the service (or 'core' if the assembly is the runtime) is added. ///
allPlatforms	IEnumerable	The set of platform subfolders to use to discover ndoc tables
options	SDKDocGenerator.GeneratorOptions	The user options governing doc generation
useAppDomain	bool
return	System

NDocForPlatform() public method

Returns the discovered NDoc table for a given platform, if it existed. If platform is not specified, we attempt to return the NDoc for the primary platform specified in the generator options.

public NDocForPlatform ( string platform = null ) : XElement>.IDictionary
platform	string
return	XElement>.IDictionary

OutputSubFolderFromNamespace() public static method

Returns the subfolder name that should be used for Amazon artifacts belonging to the specified namespace. Typically we use the service root level (the second part) in the namespace. If the namespace is not recognized as belonging to Amazon, an empty string is returned.

public static OutputSubFolderFromNamespace ( string ns ) : string
ns	string	The namespace of a discovered type (Amazon or 3rd party)
return	string

WriteNamespace() public method

public WriteNamespace ( SDKDocGenerator.FrameworkVersion version, string namespaceName ) : void
version	SDKDocGenerator.FrameworkVersion
namespaceName	string
return	void

WriteType() public method

public WriteType ( SDKDocGenerator.FrameworkVersion version, TypeWrapper type ) : void
version	SDKDocGenerator.FrameworkVersion
type	TypeWrapper
return	void