Api Class

Summary

Uses Roslyn to analyze any source files loaded in the previous pipeline along with any specified assemblies. This pipeline results in documents that represent Roslyn symbols.
Assembly
Wyam.Docs.dll
Namespace
Wyam.Docs.Pipelines
Interfaces
Base Types
graph BT Type-->Base0["Pipeline"] click Base0 "/api/Wyam.Common.Execution/Pipeline" Base0-->Base1["Object"] Type-.->Interface0["IPipeline"] click Interface0 "/api/Wyam.Common.Execution/IPipeline" Type-.->Interface1["IModuleList"] click Interface1 "/api/Wyam.Common.Modules/IModuleList" Type-.->Interface2["IList<IModule>"] Type["Api"] class Type type-node

Syntax

public class Api : Pipeline, IPipeline, IModuleList, IList<IModule>

Properties

Name Value Summary
Count int
Inherited from Pipeline
IsReadOnly bool
Inherited from Pipeline
Name string
The name of the pipeline.
Inherited from Pipeline
ProcessDocumentsOnce bool
Specifies that a given pipeline doesn't use data from other pipelines and prevents reprocessing of documents after the first pass.
Inherited from Pipeline
this[int] IModule
Inherited from Pipeline
this[string] IModule
Gets the module with the specified name.
Inherited from Pipeline

Methods

Name Value Summary
Add(IModule) void
Inherited from Pipeline
Add(IModule[]) void
Adds modules to the list. Any null items in the sequence of modules will be discarded.
Inherited from Pipeline
Add(string, IModule) void
Adds a module to the list with a specified name.
Inherited from Pipeline
AsKeyValuePairs() IEnumerable<KeyValuePair<string, IModule>>
Returns the list as a sequence of key-value pairs with the keys being the module names and the values being the module instances.
Inherited from Pipeline
Clear() void
Inherited from Pipeline
Contains(IModule) bool
Inherited from Pipeline
Contains(string) bool
Determines if the list contains a module with the specified name.
Inherited from Pipeline
CopyTo(IModule[], int) void
Inherited from Pipeline
GetEnumerator() IEnumerator<IModule>
Inherited from Pipeline
GetHashCode() int
Inherited from Pipeline
IndexOf(IModule) int
Inherited from Pipeline
IndexOf(string) int
Gets the index of the module with the specified name.
Inherited from Pipeline
Insert(int, IModule) void
Inherited from Pipeline
Insert(int, IModule[]) void
Inserts modules into the list. Any null items in the sequence of modules will be discarded.
Inherited from Pipeline
Insert(int, string, IModule) void
Inserts a module into the list with a specified name.
Inherited from Pipeline
Remove(IModule) bool
Inherited from Pipeline
Remove(string) bool
Removes a module by name.
Inherited from Pipeline
RemoveAt(int) void
Inherited from Pipeline
ToString() string
Inherited from Pipeline
TryGetValue(string, IModule) bool
Attempts to get a module with the specified name.
Inherited from Pipeline

Operators

Name Value Summary
implicit operator string(Pipeline) string
Inherited from Pipeline
GitHub