@@ -72,11 +72,14 @@ public GotenbergSharpClient(HttpClient innerClient)
7272 protected HttpClient HttpClient { get ; }
7373
7474 /// <summary>
75- /// For remote URL conversions. Works just like <see cref="HtmlToPdfAsync" />
75+ /// Converts a remote URL to PDF using Gotenberg's Chromium module.
7676 /// </summary>
77- /// <param name="request"></param>
78- /// <param name="cancelToken"></param>
79- /// <returns></returns>
77+ /// <param name="request">The URL conversion request.</param>
78+ /// <param name="cancelToken">Cancellation token for the async operation.</param>
79+ /// <returns>A stream containing the generated PDF.</returns>
80+ /// <exception cref="ArgumentNullException">Thrown when request is null.</exception>
81+ /// <exception cref="GotenbergApiException">Thrown when Gotenberg returns an error response.</exception>
82+ /// <seealso href="https://gotenberg.dev/docs/routes#convert-with-chromium">Gotenberg Chromium Route Documentation</seealso>
8083 public virtual Task < Stream > UrlToPdfAsync (
8184 UrlRequest request ,
8285 CancellationToken cancelToken = default )
@@ -87,11 +90,14 @@ public virtual Task<Stream> UrlToPdfAsync(
8790 }
8891
8992 /// <summary>
90- /// For remote URL conversions. Works just like <see cref="HtmlToPdfAsync" />
93+ /// Converts a remote URL to PDF using Gotenberg's Chromium module with a builder pattern.
9194 /// </summary>
92- /// <param name="builder"></param>
93- /// <param name="cancelToken"></param>
94- /// <returns></returns>
95+ /// <param name="builder">The builder for configuring URL conversion settings.</param>
96+ /// <param name="cancelToken">Cancellation token for the async operation.</param>
97+ /// <returns>A stream containing the generated PDF.</returns>
98+ /// <exception cref="ArgumentNullException">Thrown when builder is null.</exception>
99+ /// <exception cref="GotenbergApiException">Thrown when Gotenberg returns an error response.</exception>
100+ /// <seealso href="https://gotenberg.dev/docs/routes#convert-with-chromium">Gotenberg Chromium Route Documentation</seealso>
95101 public virtual async Task < Stream > UrlToPdfAsync (
96102 UrlRequestBuilder builder ,
97103 CancellationToken cancelToken = default )
@@ -104,12 +110,14 @@ public virtual async Task<Stream> UrlToPdfAsync(
104110 }
105111
106112 /// <summary>
107- /// Converts the specified request to a PDF document .
113+ /// Converts HTML or Markdown content to PDF using Gotenberg's Chromium module .
108114 /// </summary>
109- /// <param name="request"></param>
110- /// <param name="cancelToken"></param>
111- /// <returns></returns>
112- /// <exception cref="ArgumentNullException"></exception>
115+ /// <param name="request">The HTML/Markdown conversion request.</param>
116+ /// <param name="cancelToken">Cancellation token for the async operation.</param>
117+ /// <returns>A stream containing the generated PDF.</returns>
118+ /// <exception cref="ArgumentNullException">Thrown when request is null.</exception>
119+ /// <exception cref="GotenbergApiException">Thrown when Gotenberg returns an error response.</exception>
120+ /// <seealso href="https://gotenberg.dev/docs/routes#convert-with-chromium">Gotenberg Chromium Route Documentation</seealso>
113121 public virtual Task < Stream > HtmlToPdfAsync (
114122 HtmlRequest request ,
115123 CancellationToken cancelToken = default )
@@ -120,12 +128,14 @@ public virtual Task<Stream> HtmlToPdfAsync(
120128 }
121129
122130 /// <summary>
123- /// Converts the specified request to a PDF document .
131+ /// Converts HTML or Markdown content to PDF using Gotenberg's Chromium module with a builder pattern .
124132 /// </summary>
125- /// <param name="builder"></param>
126- /// <param name="cancelToken"></param>
127- /// <returns></returns>
128- /// <exception cref="ArgumentNullException"></exception>
133+ /// <param name="builder">The builder for configuring HTML/Markdown conversion settings.</param>
134+ /// <param name="cancelToken">Cancellation token for the async operation.</param>
135+ /// <returns>A stream containing the generated PDF.</returns>
136+ /// <exception cref="ArgumentNullException">Thrown when builder is null.</exception>
137+ /// <exception cref="GotenbergApiException">Thrown when Gotenberg returns an error response.</exception>
138+ /// <seealso href="https://gotenberg.dev/docs/routes#convert-with-chromium">Gotenberg Chromium Route Documentation</seealso>
129139 public virtual async Task < Stream > HtmlToPdfAsync (
130140 HtmlRequestBuilder builder ,
131141 CancellationToken cancelToken = default )
@@ -138,12 +148,14 @@ public virtual async Task<Stream> HtmlToPdfAsync(
138148 }
139149
140150 /// <summary>
141- /// Merges items specified by the request
151+ /// Merges multiple PDF files into a single PDF using Gotenberg's PDF engines module.
142152 /// </summary>
143- /// <param name="request"></param>
144- /// <param name="cancelToken"></param>
145- /// <returns></returns>
146- /// <exception cref="ArgumentNullException"></exception>
153+ /// <param name="request">The merge request containing PDFs to merge.</param>
154+ /// <param name="cancelToken">Cancellation token for the async operation.</param>
155+ /// <returns>A stream containing the merged PDF.</returns>
156+ /// <exception cref="ArgumentNullException">Thrown when request is null.</exception>
157+ /// <exception cref="GotenbergApiException">Thrown when Gotenberg returns an error response.</exception>
158+ /// <seealso href="https://gotenberg.dev/docs/routes#merge-pdfs-route">Gotenberg Merge PDFs Route Documentation</seealso>
147159 public virtual Task < Stream > MergePdfsAsync (
148160 MergeRequest request ,
149161 CancellationToken cancelToken = default )
@@ -154,10 +166,14 @@ public virtual Task<Stream> MergePdfsAsync(
154166 }
155167
156168 /// <summary>
157- /// Converts one or more office documents into a merged pdf .
169+ /// Converts and merges Office documents (Word, Excel, PowerPoint, etc.) into a single PDF using Gotenberg's LibreOffice module .
158170 /// </summary>
159- /// <param name="request"></param>
160- /// <param name="cancelToken"></param>
171+ /// <param name="request">The merge request containing Office documents to convert and merge.</param>
172+ /// <param name="cancelToken">Cancellation token for the async operation.</param>
173+ /// <returns>A stream containing the merged PDF.</returns>
174+ /// <exception cref="ArgumentNullException">Thrown when request is null.</exception>
175+ /// <exception cref="GotenbergApiException">Thrown when Gotenberg returns an error response.</exception>
176+ /// <seealso href="https://gotenberg.dev/docs/routes#convert-with-libreoffice">Gotenberg LibreOffice Route Documentation</seealso>
161177 public virtual Task < Stream > MergeOfficeDocsAsync (
162178 MergeOfficeRequest request ,
163179 CancellationToken cancelToken = default )
@@ -168,10 +184,14 @@ public virtual Task<Stream> MergeOfficeDocsAsync(
168184 }
169185
170186 /// <summary>
171- /// Converts one or more office documents into a merged pdf .
187+ /// Converts and merges Office documents into a single PDF using Gotenberg's LibreOffice module with a builder pattern .
172188 /// </summary>
173- /// <param name="builder"></param>
174- /// <param name="cancelToken"></param>
189+ /// <param name="builder">The builder for configuring Office document merge settings.</param>
190+ /// <param name="cancelToken">Cancellation token for the async operation.</param>
191+ /// <returns>A stream containing the merged PDF.</returns>
192+ /// <exception cref="ArgumentNullException">Thrown when builder is null.</exception>
193+ /// <exception cref="GotenbergApiException">Thrown when Gotenberg returns an error response.</exception>
194+ /// <seealso href="https://gotenberg.dev/docs/routes#convert-with-libreoffice">Gotenberg LibreOffice Route Documentation</seealso>
175195 public virtual async Task < Stream > MergeOfficeDocsAsync (
176196 MergeOfficeBuilder builder ,
177197 CancellationToken cancelToken = default )
@@ -191,6 +211,7 @@ public virtual async Task<Stream> MergeOfficeDocsAsync(
191211 /// <returns>A stream containing the converted PDF.</returns>
192212 /// <exception cref="ArgumentNullException">Thrown when request is null.</exception>
193213 /// <exception cref="GotenbergApiException">Thrown when Gotenberg returns an error response.</exception>
214+ /// <seealso href="https://gotenberg.dev/docs/routes#convert-into-pdfa--pdfua-route">Gotenberg PDF/A Conversion Route Documentation</seealso>
194215 public virtual Task < Stream > ConvertPdfDocumentsAsync (
195216 PdfConversionRequest request ,
196217 CancellationToken cancelToken = default )
@@ -208,6 +229,7 @@ public virtual Task<Stream> ConvertPdfDocumentsAsync(
208229 /// <returns>A stream containing the converted PDF.</returns>
209230 /// <exception cref="ArgumentNullException">Thrown when builder is null.</exception>
210231 /// <exception cref="GotenbergApiException">Thrown when Gotenberg returns an error response.</exception>
232+ /// <seealso href="https://gotenberg.dev/docs/routes#convert-into-pdfa--pdfua-route">Gotenberg PDF/A Conversion Route Documentation</seealso>
211233 public virtual async Task < Stream > ConvertPdfDocumentsAsync (
212234 PdfConversionBuilder builder ,
213235 CancellationToken cancelToken = default )
0 commit comments