Commit d065574
Add comprehensive XML documentation to configuration and DI
Completes Phase 7 by documenting configuration options and dependency
injection setup - critical for users getting started with the library.
Documented classes:
- TypedClientServiceCollectionExtensions: Both AddGotenbergSharpClient
overloads with setup guidance and appsettings.json examples
- GotenbergSharpClientOptions: All properties with defaults and use cases
(TimeOut: 3min, ServiceUrl: localhost:3000, RetryPolicy, BasicAuth)
- RetryOptions: All retry configuration properties with exponential
backoff formula and defaults
Key improvements:
- CRITICAL: Users now know how to configure the client via DI
- Documented all default values (TimeOut, ServiceUrl, RetryCount, etc.)
- Explained exponential backoff formula: Math.Pow(BackoffPower, retryAttempt)
- Clarified Docker Compose URL setup (http://gotenberg:3000)
- Documented retry behavior (disabled by default, 3 retries when enabled)
- Added appsettings.json section guidance
This documentation is essential for first-time users setting up the client.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>1 parent d8612f3 commit d065574
3 files changed
Lines changed: 63 additions & 5 deletions
File tree
- src/Gotenberg.Sharp.Api.Client
- Domain/Settings
- Extensions
Lines changed: 20 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
18 | 25 | | |
19 | 26 | | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
20 | 31 | | |
21 | 32 | | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
22 | 37 | | |
23 | 38 | | |
24 | 39 | | |
25 | | - | |
| 40 | + | |
26 | 41 | | |
27 | 42 | | |
28 | 43 | | |
29 | 44 | | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
30 | 49 | | |
31 | 50 | | |
32 | 51 | | |
| |||
Lines changed: 18 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
18 | 21 | | |
19 | 22 | | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
20 | 27 | | |
21 | 28 | | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
22 | 33 | | |
23 | 34 | | |
24 | 35 | | |
25 | | - | |
26 | | - | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
27 | 39 | | |
28 | | - | |
29 | 40 | | |
30 | 41 | | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
31 | 46 | | |
32 | 47 | | |
Lines changed: 25 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
28 | 31 | | |
29 | 32 | | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
30 | 44 | | |
31 | 45 | | |
32 | 46 | | |
| |||
51 | 65 | | |
52 | 66 | | |
53 | 67 | | |
54 | | - | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
55 | 79 | | |
56 | 80 | | |
57 | 81 | | |
| |||
0 commit comments