Skip to content

Commit

Permalink
Fixed the documentation in the generated enum.
Browse files Browse the repository at this point in the history
  • Loading branch information
@mwadams
mwadams committed Mar 13, 2024
1 parent b77289b commit 38fa240
Show file tree
Hide file tree
Showing 9 changed files with 532 additions and 888 deletions.
240 changes: 110 additions & 130 deletions ...Generation.201909/Corvus.Json.CodeGeneration.Draft201909/Generators/CodeGenerator.Enum.cs
View file

Large diffs are not rendered by default.

240 changes: 110 additions & 130 deletions ...Generation.202012/Corvus.Json.CodeGeneration.Draft202012/Generators/CodeGenerator.Enum.cs
View file

Large diffs are not rendered by default.

240 changes: 110 additions & 130 deletions ....Json.CodeGeneration.6/Corvus.Json.CodeGeneration.Draft6/Generators/CodeGenerator.Enum.cs
View file

Large diffs are not rendered by default.

240 changes: 110 additions & 130 deletions ....Json.CodeGeneration.7/Corvus.Json.CodeGeneration.Draft7/Generators/CodeGenerator.Enum.cs
View file

Large diffs are not rendered by default.

40 changes: 8 additions & 32 deletions Solutions/Corvus.Json.CodeGeneration.Abstractions/SharedTemplates/CodeGenerator.Enum.tt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,68 +41,47 @@ public readonly partial struct <#= TypeDeclaration.DotnetTypeName #>
if (enumValue.IsString)
{ #>
/// <summary>
/// <#= enumValue.AsPropertyName #>.
/// Gets <#= enumValue.RawStringValue #> as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static readonly <#= TypeDeclaration.DotnetTypeName #> <#= enumValue.AsPropertyName #> = <#= TypeDeclaration.DotnetTypeName #>.Parse(<#= enumValue.SerializedValue #>);
/// <summary>
/// Gets the <#= enumValue.AsPropertyName #> as a raw UTF8 string.
/// Gets <#= enumValue.RawStringValue #> as a UTF8 string.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static ReadOnlySpan<byte> <#= enumValue.AsPropertyName #>Utf8 => <#= enumValue.RawStringValue #>u8;
<# }
else if (enumValue.IsBoolean)
{ #>
/// <summary>
/// [{Title} || Item <#= enumItemIndex#>] (with predictable naming).
/// Gets <#= enumValue.SerializedValue #> as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static readonly <#= TypeDeclaration.DotnetTypeName #> Item<#= enumItemIndex #> = <#= TypeDeclaration.DotnetTypeName #>.Parse(<#= enumValue.SerializedValue #>);
<# }
else if (enumValue.IsNumber)
{ #>
/// <summary>
/// [{Title} || Item <#= enumItemIndex #>] (with predictable naming).
/// Gets <#= enumValue.SerializedValue #> as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static readonly <#= TypeDeclaration.DotnetTypeName #> Item<#= enumItemIndex #> = <#= TypeDeclaration.DotnetTypeName #>.Parse(<#= enumValue.SerializedValue #>);
<# }
else if (enumValue.IsObject)
{ #>
/// <summary>
/// [{Title} || Item <#= enumItemIndex#>] (with predictable naming).
/// Gets <#= enumValue.SerializedValue #> as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static readonly <#= TypeDeclaration.DotnetTypeName #> Item<#= enumItemIndex#> = <#= TypeDeclaration.DotnetTypeName #>.Parse(<#= enumValue.SerializedValue #>);
<# }
else if (enumValue.IsArray)
{ #>
/// <summary>
/// [{Title} || Item <#= enumItemIndex #>] (with predictable naming).
/// Gets <#= enumValue.SerializedValue #> as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static readonly <#= TypeDeclaration.DotnetTypeName #> Item<#= enumItemIndex #> = <#= TypeDeclaration.DotnetTypeName #>.Parse(<#= enumValue.SerializedValue #>);
<# }
else if (enumValue.IsNull)
{ #>
/// <summary>
/// [{Title} || Item <#= enumItemIndex #>] (with predictable naming).
/// Gets "null" as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static readonly <#= TypeDeclaration.DotnetTypeName #> Item<#= enumItemIndex#> = <#= TypeDeclaration.DotnetTypeName #>.Parse("null");
<# }
++enumItemIndex;
Expand All @@ -114,11 +93,8 @@ public readonly partial struct <#= TypeDeclaration.DotnetTypeName #>
if (enumValue.IsString)
{ #>
/// <summary>
/// [{Title} || Item <#= enumItemIndex #>] (with predictable naming).
/// Gets <#= enumValue.RawStringValue #> as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
internal static readonly <#= TypeDeclaration.DotnetTypeName #> Item<#= enumItemIndex #> = <#= TypeDeclaration.DotnetTypeName #>.Parse(<#= enumValue.SerializedValue #>);
<# }
enumItemIndex++;
Expand Down
105 changes: 21 additions & 84 deletions Solutions/Corvus.Json.JsonSchema.Draft201909/Draft201909/Validation.SimpleTypes.Enum.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,158 +27,95 @@ public readonly partial struct SimpleTypes
public static class EnumValues
{
/// <summary>
/// Array.
/// Gets "array" as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static readonly SimpleTypes Array = SimpleTypes.Parse("\"array\"");
/// <summary>
/// Gets the Array as a raw UTF8 string.
/// Gets "array" as a UTF8 string.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static ReadOnlySpan<byte> ArrayUtf8 => "array"u8;

/// <summary>
/// Boolean.
/// Gets "boolean" as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static readonly SimpleTypes Boolean = SimpleTypes.Parse("\"boolean\"");
/// <summary>
/// Gets the Boolean as a raw UTF8 string.
/// Gets "boolean" as a UTF8 string.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static ReadOnlySpan<byte> BooleanUtf8 => "boolean"u8;

/// <summary>
/// Integer.
/// Gets "integer" as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static readonly SimpleTypes Integer = SimpleTypes.Parse("\"integer\"");
/// <summary>
/// Gets the Integer as a raw UTF8 string.
/// Gets "integer" as a UTF8 string.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static ReadOnlySpan<byte> IntegerUtf8 => "integer"u8;

/// <summary>
/// Null.
/// Gets "null" as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static readonly SimpleTypes Null = SimpleTypes.Parse("\"null\"");
/// <summary>
/// Gets the Null as a raw UTF8 string.
/// Gets "null" as a UTF8 string.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static ReadOnlySpan<byte> NullUtf8 => "null"u8;

/// <summary>
/// Number.
/// Gets "number" as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static readonly SimpleTypes Number = SimpleTypes.Parse("\"number\"");
/// <summary>
/// Gets the Number as a raw UTF8 string.
/// Gets "number" as a UTF8 string.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static ReadOnlySpan<byte> NumberUtf8 => "number"u8;

/// <summary>
/// Object.
/// Gets "object" as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static readonly SimpleTypes Object = SimpleTypes.Parse("\"object\"");
/// <summary>
/// Gets the Object as a raw UTF8 string.
/// Gets "object" as a UTF8 string.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static ReadOnlySpan<byte> ObjectUtf8 => "object"u8;

/// <summary>
/// String.
/// Gets "string" as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static readonly SimpleTypes String = SimpleTypes.Parse("\"string\"");
/// <summary>
/// Gets the String as a raw UTF8 string.
/// Gets "string" as a UTF8 string.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
public static ReadOnlySpan<byte> StringUtf8 => "string"u8;

/// <summary>
/// [{Title} || Item 0] (with predictable naming).
/// Gets "array" as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
internal static readonly SimpleTypes Item0 = SimpleTypes.Parse("\"array\"");
/// <summary>
/// [{Title} || Item 1] (with predictable naming).
/// Gets "boolean" as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
internal static readonly SimpleTypes Item1 = SimpleTypes.Parse("\"boolean\"");
/// <summary>
/// [{Title} || Item 2] (with predictable naming).
/// Gets "integer" as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
internal static readonly SimpleTypes Item2 = SimpleTypes.Parse("\"integer\"");
/// <summary>
/// [{Title} || Item 3] (with predictable naming).
/// Gets "null" as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
internal static readonly SimpleTypes Item3 = SimpleTypes.Parse("\"null\"");
/// <summary>
/// [{Title} || Item 4] (with predictable naming).
/// Gets "number" as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
internal static readonly SimpleTypes Item4 = SimpleTypes.Parse("\"number\"");
/// <summary>
/// [{Title} || Item 5] (with predictable naming).
/// Gets "object" as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
internal static readonly SimpleTypes Item5 = SimpleTypes.Parse("\"object\"");
/// <summary>
/// [{Title} || Item 6] (with predictable naming).
/// Gets "string" as a JSON value.
/// </summary>
/// <remarks>
/// {Description}.
/// </remarks>
internal static readonly SimpleTypes Item6 = SimpleTypes.Parse("\"string\"");
}
}
Expand Down
Loading

0 comments on commit 38fa240

Please sign in to comment.