SolutionConfig

Represents the configuration for an individual solution within the multi-solution setup.

Syntax

public class SolutionConfig

Inheritance

Properties

DocsPath

[JsonPropertyName("docsPath")]
public string DocsPath { get; set; }
Gets or sets the path to pre-generated documentation.

Returns

string The path to existing documentation files when using external source.

Exclude

[JsonPropertyName("exclude")]
public List<string> Exclude { get; set; }
Gets or sets the list of project patterns to exclude.

Returns

List<string> Patterns for .csproj files that should be excluded from processing.

MergeConfig

[JsonPropertyName("mergeConfig")]
public MergeConfig MergeConfig { get; set; }
Gets or sets the merge configuration for external sources.

Returns

MergeConfig Settings for how to merge external documentation into the combined site.

Name

[JsonPropertyName("name")]
public string Name { get; set; }
Gets or sets the display name of the solution.

Returns

string The human-readable name used in navigation and display.
[JsonPropertyName("navigation")]
public SolutionNavigationConfig Navigation { get; set; }
Gets or sets the navigation configuration for this solution.

Returns

SolutionNavigationConfig The structure and organization of navigation elements for this solution’s tab.

OutputPath

[JsonPropertyName("outputPath")]
public string OutputPath { get; set; }
Gets or sets the output path for this solution’s documentation.

Returns

string The subdirectory name where this solution’s docs will be placed in the final output.

Path

[JsonPropertyName("path")]
public string Path { get; set; }
Gets or sets the path to the solution source code.

Returns

string The relative or absolute path to the solution’s source directory.

Projects

[JsonPropertyName("projects")]
public List<string> Projects { get; set; }
Gets or sets the list of project files to include.

Returns

List<string> Patterns or specific filenames for .csproj files to process.

Source

[JsonPropertyName("source")]
public string Source { get; set; }
Gets or sets the source type for this solution.

Returns

string The method used to generate documentation for this solution.

Tab

[JsonPropertyName("tab")]
public string Tab { get; set; }
Gets or sets the tab name for this solution in the navigation.

Returns

string The text displayed in the top-level tab for this solution.

Remarks

This class defines how a single solution should be processed and integrated into the combined documentation site, including its tab configuration and content sources.