Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions FirstClassErrors.Cli/CliConfiguration.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ internal sealed class CliConfiguration {
/// <summary>Default assemblies to document (used when neither --solution nor --assemblies is given).</summary>
public List<string>? Assemblies { get; set; }

/// <summary>Default output format (e.g. <c>json</c>, <c>markdown</c>).</summary>
/// <summary>Default output format (<c>json</c>, <c>markdown</c> or <c>html</c>).</summary>
public string? Format { get; set; }

/// <summary>Default Markdown layout (<c>single</c> or <c>split</c>).</summary>
/// <summary>Default document layout (<c>single</c> or <c>split</c>); applies to the <c>markdown</c> and <c>html</c> formats.</summary>
public string? Layout { get; set; }

/// <summary>Default language of the generated documentation (e.g. <c>en</c>, <c>fr</c>, <c>es</c>, <c>de</c>, <c>sv</c>).</summary>
Expand Down
4 changes: 2 additions & 2 deletions FirstClassErrors.Cli/GenerateSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ internal sealed class GenerateSettings : ConfigScopedSettings {
public string? OutputPath { get; set; }

[CommandOption("-f|--format <FORMAT>")]
[Description("Output format: json or markdown (alias: md). Falls back to the configuration, then json.")]
[Description("Output format: json, markdown (alias: md) or html. Falls back to the configuration, then json.")]
public string? Format { get; set; }

[CommandOption("--layout <LAYOUT>")]
[Description("Markdown layout: single or split. Falls back to the configuration, then single.")]
[Description("Document layout: single or split. Applies to the markdown and html formats (json is single only). Falls back to the configuration, then single.")]
public string? Layout { get; set; }

[CommandOption("-l|--language <LANGUAGE>")]
Expand Down
2 changes: 2 additions & 0 deletions FirstClassErrors.Cli/RendererAddCommand.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#region Usings declarations

using System.ComponentModel;
using System.Reflection;

using FirstClassErrors.GenDoc.Rendering;
Expand All @@ -14,6 +15,7 @@ namespace FirstClassErrors.Cli;
internal sealed class RendererReferenceSettings : ConfigScopedSettings {

[CommandArgument(0, "<PATH>")]
[Description("Path to the renderer library (.dll) to register; stored as given, so relative paths stay portable.")]
public string LibraryPath { get; set; } = string.Empty;

}
Expand Down
Loading