Class ReferenceDocsRequest
Namespace: Cephalon.ReferenceDocs.Generation
Assembly: Cephalon.ReferenceDocs.dll
Describes the input required to generate Cephalon reference documentation.
public sealed class ReferenceDocsRequestInheritance
Section titled “Inheritance”Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
Section titled “Constructors”ReferenceDocsRequest(string, string, string, string, IReadOnlyList<string>?)
Section titled “ ReferenceDocsRequest(string, string, string, string, IReadOnlyList<string>?)”Creates a new reference docs request.
public ReferenceDocsRequest(string rootPath, string outputPath, string configuration = "Debug", string targetFramework = "net10.0", IReadOnlyList<string>? assemblies = null)Parameters
Section titled “Parameters”rootPath string
The repository root path.
outputPath string
The output directory where reference docs should be written.
configuration string
The build configuration to read from.
targetFramework string
The target framework to read from.
assemblies IReadOnlyList<string>?
The assemblies to document. When omitted, the generator uses its curated defaults.
Properties
Section titled “Properties”Assemblies
Section titled “ Assemblies”Gets the assemblies to document. When empty, the generator uses its curated defaults.
public IReadOnlyList<string> Assemblies { get; }Property Value
Section titled “Property Value”Configuration
Section titled “ Configuration”Gets the build configuration to read from.
public string Configuration { get; }Property Value
Section titled “Property Value”OutputPath
Section titled “ OutputPath”Gets the output directory where reference docs should be written.
public string OutputPath { get; }Property Value
Section titled “Property Value”RootPath
Section titled “ RootPath”Gets the repository root path.
public string RootPath { get; }Property Value
Section titled “Property Value”TargetFramework
Section titled “ TargetFramework”Gets the target framework to read from.
public string TargetFramework { get; }