C# Class SDKDocGenerator.SdkDocGenerator

Documentation generator for the AWS SDK for .NET v3+ codebase.
Show file Open project: aws/aws-sdk-net Class Usage Examples

Public Methods

Method Description
Execute ( SDKDocGenerator.GeneratorOptions options ) : int

Runs the doc generator to produce or update a consistent documentation set for the SDK.

Private Methods

Method Description
ConstructGenerationManifests ( ) : IList

Enumerates the assembly, folder and platform settings in the options to construct a per-service manifest that we will then process. Our preferred documentation source is for the 'net45' platform but if a subfolder does not exist under the root for this platform, we'll generate using the assemblies in the first subfolder we find.

Currently we only construct manifests for the assemblies we find in the preferred or first platform subfolder. Distinct assemblies that exist outside this folder do not get included.

CopyVersionInfoManifest ( ) : void

Copies the json file containing the version information for each SDK assembly (by service) into the output docs folder.

GenerateTableOfContents ( IList manifests ) : void
Info ( string message ) : void
InfoVerbose ( string message ) : void
SetOptionsForTestMode ( ) : void

Sets the generation options so as to perform a limited generation pass on one platform and a handul of assemblies to allow verification of doc generator changes.

Method Details

Execute() public method

Runs the doc generator to produce or update a consistent documentation set for the SDK.
public Execute ( SDKDocGenerator.GeneratorOptions options ) : int
options SDKDocGenerator.GeneratorOptions
return int