Skip to content

Commit 6e89d49

Browse files
Jabenclaude
andcommitted
Add comprehensive XML documentation to critical enumerations
Completes Phase 5 by documenting three critical enumerations with actual values that users need to know. Documented enumerations: - Margins: Added actual inch measurements for None (0"), Default (0.39"), Normal (1"), and Large (2") - DimensionUnitType: Documented all unit types with explanations and common use cases (Points, Pixels, Inches, Millimeters, Centimeters, Picas) - ExtraUrlResourceType: Clarified LinkTag (CSS) vs ScriptTag (JavaScript) with HTML tag examples Key improvements: - CRITICAL: Users can now see actual margin values in IntelliSense - Added context for when to use each unit type - Explained relationship to CSS and HTML tags for extra resources - All enum values now have clear, concise descriptions 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 1db8eeb commit 6e89d49

3 files changed

Lines changed: 59 additions & 7 deletions

File tree

src/Gotenberg.Sharp.Api.Client/Domain/Builders/Faceted/Margins.cs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,28 @@
1515

1616
namespace Gotenberg.Sharp.API.Client.Domain.Builders.Faceted;
1717

18+
/// <summary>
19+
/// Predefined margin sizes for PDF page properties. All values are in inches.
20+
/// </summary>
1821
public enum Margins
1922
{
23+
/// <summary>
24+
/// No margins (0 inches on all sides).
25+
/// </summary>
2026
None = 0,
2127

28+
/// <summary>
29+
/// Default margins (0.39 inches on all sides).
30+
/// </summary>
2231
Default = 1,
2332

33+
/// <summary>
34+
/// Normal margins (1 inch on all sides).
35+
/// </summary>
2436
Normal = 2,
2537

38+
/// <summary>
39+
/// Large margins (2 inches on all sides).
40+
/// </summary>
2641
Large = 3
2742
}

src/Gotenberg.Sharp.Api.Client/Domain/Dimensions/DimensionUnitType.cs

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,39 @@
1717

1818
namespace Gotenberg.Sharp.API.Client.Domain.Dimensions
1919
{
20+
/// <summary>
21+
/// Units of measurement for PDF page dimensions and margins.
22+
/// </summary>
2023
public enum DimensionUnitType
2124
{
22-
[Description("pt")] Points, // Points
23-
[Description("px")] Pixels, // Pixels
24-
[Description("in")] Inches, // Inches
25-
[Description("mm")] Millimeters, // Millimeters
26-
[Description("cm")] Centimeters, // Centimeters
27-
[Description("pc")] Picas // Picas
25+
/// <summary>
26+
/// Points (1/72 of an inch). Common in typography and print design.
27+
/// </summary>
28+
[Description("pt")] Points,
29+
30+
/// <summary>
31+
/// Pixels (assumes 96 DPI). Common for screen dimensions.
32+
/// </summary>
33+
[Description("px")] Pixels,
34+
35+
/// <summary>
36+
/// Inches. Common in US print specifications.
37+
/// </summary>
38+
[Description("in")] Inches,
39+
40+
/// <summary>
41+
/// Millimeters. Common in international print specifications.
42+
/// </summary>
43+
[Description("mm")] Millimeters,
44+
45+
/// <summary>
46+
/// Centimeters. Common in international specifications.
47+
/// </summary>
48+
[Description("cm")] Centimeters,
49+
50+
/// <summary>
51+
/// Picas (1/6 of an inch). Common in typography and print design.
52+
/// </summary>
53+
[Description("pc")] Picas
2854
}
2955
}

src/Gotenberg.Sharp.Api.Client/Domain/Requests/Facets/UrlExtras/ExtraUrlResourceType.cs

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,23 @@
1717

1818
namespace Gotenberg.Sharp.API.Client.Domain.Requests.Facets.UrlExtras;
1919

20+
/// <summary>
21+
/// Types of external resources that can be injected into URL-based PDF conversions.
22+
/// </summary>
2023
public enum ExtraUrlResourceType
2124
{
22-
25+
/// <summary>
26+
/// No resource type specified.
27+
/// </summary>
2328
None = 0,
2429

30+
/// <summary>
31+
/// CSS stylesheet injected via link tag (&lt;link rel="stylesheet" href="..."&gt;).
32+
/// </summary>
2533
LinkTag = 1,
2634

35+
/// <summary>
36+
/// JavaScript file injected via script tag (&lt;script src="..."&gt;&lt;/script&gt;).
37+
/// </summary>
2738
ScriptTag = 2
2839
}

0 commit comments

Comments
 (0)