Skip to content

Commit 64292e1

Browse files
Kate IvanovaiText-CI
Kate Ivanova
authored and
iText-CI
committed
Fix javadocs of SvgConverter
DEVSIX-5068 Autoported commit. Original commit hash: [075fb5390]
1 parent e3c7829 commit 64292e1

File tree

2 files changed

+67
-37
lines changed

2 files changed

+67
-37
lines changed

‎itext/itext.svg/itext/svg/converter/SvgConverter.cs

Lines changed: 66 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ public static void DrawOnDocument(String content, PdfDocument document, int page
119119
/// Draws a String containing valid SVG to a document, on a given page
120120
/// number on the provided x and y coordinate.
121121
/// </summary>
122-
/// <param name="content">the Stream object containing valid SVG content</param>
122+
/// <param name="content">the String value containing valid SVG content</param>
123123
/// <param name="document">
124124
/// the
125125
/// <see cref="iText.Kernel.Pdf.PdfDocument"/>
@@ -136,7 +136,7 @@ public static void DrawOnDocument(String content, PdfDocument document, int page
136136
/// Draws a String containing valid SVG to a document, on a given page
137137
/// number on the provided x and y coordinate.
138138
/// </summary>
139-
/// <param name="content">the Stream object containing valid SVG content</param>
139+
/// <param name="content">the String value containing valid SVG content</param>
140140
/// <param name="document">
141141
/// the
142142
/// <see cref="iText.Kernel.Pdf.PdfDocument"/>
@@ -156,7 +156,11 @@ public static void DrawOnDocument(String content, PdfDocument document, int page
156156
/// Draws a Stream containing valid SVG to a document, on a given page
157157
/// number ate the origni of the page.
158158
/// </summary>
159-
/// <param name="stream">the Stream object containing valid SVG content</param>
159+
/// <param name="stream">
160+
/// the
161+
/// <see cref="System.IO.Stream">Stream</see>
162+
/// containing valid SVG content
163+
/// </param>
160164
/// <param name="document">
161165
/// the
162166
/// <see cref="iText.Kernel.Pdf.PdfDocument"/>
@@ -171,7 +175,11 @@ public static void DrawOnDocument(Stream stream, PdfDocument document, int pageN
171175
/// Draws a Stream containing valid SVG to a document, on a given page
172176
/// number on the provided x and y coordinate.
173177
/// </summary>
174-
/// <param name="stream">the Stream object containing valid SVG content</param>
178+
/// <param name="stream">
179+
/// the
180+
/// <see cref="System.IO.Stream">Stream</see>
181+
/// containing valid SVG content
182+
/// </param>
175183
/// <param name="document">
176184
/// the
177185
/// <see cref="iText.Kernel.Pdf.PdfDocument"/>
@@ -189,7 +197,11 @@ public static void DrawOnDocument(Stream stream, PdfDocument document, int pageN
189197
/// Draws a Stream containing valid SVG to a document, on a given page
190198
/// number on the provided x and y coordinate.
191199
/// </summary>
192-
/// <param name="stream">the Stream object containing valid SVG content</param>
200+
/// <param name="stream">
201+
/// the
202+
/// <see cref="System.IO.Stream">Stream</see>
203+
/// containing valid SVG content
204+
/// </param>
193205
/// <param name="document">
194206
/// the
195207
/// <see cref="iText.Kernel.Pdf.PdfDocument"/>
@@ -206,7 +218,11 @@ public static void DrawOnDocument(Stream stream, PdfDocument document, int pageN
206218
/// Draws a Stream containing valid SVG to a document, on a given page
207219
/// number on the provided x and y coordinate.
208220
/// </summary>
209-
/// <param name="stream">the Stream object containing valid SVG content</param>
221+
/// <param name="stream">
222+
/// the
223+
/// <see cref="System.IO.Stream">Stream</see>
224+
/// containing valid SVG content
225+
/// </param>
210226
/// <param name="document">
211227
/// the
212228
/// <see cref="iText.Kernel.Pdf.PdfDocument"/>
@@ -509,7 +525,7 @@ public static void CreatePdf(FileInfo svgFile, FileInfo pdfFile) {
509525
/// <param name="props">
510526
/// a
511527
/// <see cref="iText.Svg.Processors.ISvgConverterProperties"/>
512-
/// instance
528+
/// an instance for extra properties to customize the behavior
513529
/// </param>
514530
public static void CreatePdf(FileInfo svgFile, FileInfo pdfFile, ISvgConverterProperties props) {
515531
CreatePdf(svgFile, pdfFile, props, null);
@@ -567,7 +583,7 @@ public static void CreatePdf(FileInfo svgFile, FileInfo pdfFile, WriterPropertie
567583
/// <param name="props">
568584
/// a
569585
/// <see cref="iText.Svg.Processors.ISvgConverterProperties"/>
570-
/// instance
586+
/// an instance for extra properties to customize the behavior
571587
/// </param>
572588
/// <param name="writerProps">
573589
/// a
@@ -597,9 +613,13 @@ public static void CreatePdf(FileInfo svgFile, FileInfo pdfFile, ISvgConverterPr
597613
/// Copies properties from custom ISvgConverterProperties into new SvgConverterProperties.
598614
/// Since ISvgConverterProperties itself is immutable we have to do it.
599615
/// </remarks>
600-
/// <param name="props"/>
601-
/// <param name="baseUri"/>
602-
/// <returns/>
616+
/// <param name="props">
617+
///
618+
/// <see cref="iText.Svg.Processors.ISvgConverterProperties"/>
619+
/// an instance for extra properties to customize the behavior
620+
/// </param>
621+
/// <param name="baseUri">the directory of new SvgConverterProperties</param>
622+
/// <returns>new SvgConverterProperties.</returns>
603623
private static SvgConverterProperties ConvertToSvgConverterProps(ISvgConverterProperties props, String baseUri
604624
) {
605625
return new SvgConverterProperties().SetBaseUri(baseUri).SetMediaDeviceDescription(props.GetMediaDeviceDescription
@@ -627,9 +647,9 @@ public static void CreatePdf(Stream svgStream, Stream pdfDest) {
627647
/// containing the SVG
628648
/// </param>
629649
/// <param name="pdfDest">PDF destination outputStream</param>
630-
/// <param name="writerprops">writerproperties for the pdf document</param>
631-
public static void CreatePdf(Stream svgStream, Stream pdfDest, WriterProperties writerprops) {
632-
CreatePdf(svgStream, pdfDest, null, writerprops);
650+
/// <param name="writerProps">writer properties for the pdf document</param>
651+
public static void CreatePdf(Stream svgStream, Stream pdfDest, WriterProperties writerProps) {
652+
CreatePdf(svgStream, pdfDest, null, writerProps);
633653
}
634654

635655
/// <summary>Create a single page pdf containing the SVG on its page using the default processing and drawing logic
@@ -641,9 +661,9 @@ public static void CreatePdf(Stream svgStream, Stream pdfDest, WriterProperties
641661
/// </param>
642662
/// <param name="pdfDest">PDF destination outputStream</param>
643663
/// <param name="props">
644-
/// Svg
664+
///
645665
/// <see cref="iText.Svg.Processors.ISvgConverterProperties"/>
646-
/// to change default behaviour
666+
/// an instance for extra properties to customize the behavior
647667
/// </param>
648668
public static void CreatePdf(Stream svgStream, Stream pdfDest, ISvgConverterProperties props) {
649669
CreatePdf(svgStream, pdfDest, props, null);
@@ -656,12 +676,12 @@ public static void CreatePdf(Stream svgStream, Stream pdfDest, ISvgConverterProp
656676
/// <see cref="System.IO.Stream">Stream</see>
657677
/// containing the SVG
658678
/// </param>
679+
/// <param name="pdfDest">PDF destination outputStream</param>
659680
/// <param name="props">
660681
///
661682
/// <see cref="iText.Svg.Processors.ISvgConverterProperties"/>
662-
/// to change default behaviour
683+
/// an instance for extra properties to customize the behavior
663684
/// </param>
664-
/// <param name="pdfDest">PDF destination outputStream</param>
665685
/// <param name="writerProps">
666686
///
667687
/// <see cref="iText.Kernel.Pdf.WriterProperties"/>
@@ -792,7 +812,7 @@ public static PdfFormXObject ConvertToXObject(String content, PdfDocument docume
792812
/// <param name="props">
793813
///
794814
/// <see cref="iText.Svg.Processors.ISvgConverterProperties"/>
795-
/// to customize the behavior
815+
/// an instance for extra properties to customize the behavior
796816
/// </param>
797817
/// <returns>
798818
/// a
@@ -841,7 +861,7 @@ public static PdfFormXObject ConvertToXObject(String content, PdfDocument docume
841861
/// <param name="stream">
842862
/// the
843863
/// <see cref="System.IO.Stream">Stream</see>
844-
/// object containing valid SVG content
864+
/// containing valid SVG content
845865
/// </param>
846866
/// <param name="document">
847867
/// the
@@ -851,7 +871,7 @@ public static PdfFormXObject ConvertToXObject(String content, PdfDocument docume
851871
/// <param name="props">
852872
///
853873
/// <see cref="iText.Svg.Processors.ISvgConverterProperties"/>
854-
/// to customize the behavior
874+
/// an instance for extra properties to customize the behavior
855875
/// </param>
856876
/// <returns>
857877
/// a
@@ -914,7 +934,7 @@ private static PdfFormXObject ConvertToXObject(ISvgProcessorResult processorResu
914934
/// <param name="stream">
915935
/// the
916936
/// <see cref="System.IO.Stream">Stream</see>
917-
/// object containing valid SVG content
937+
/// containing valid SVG content
918938
/// </param>
919939
/// <param name="document">
920940
/// the
@@ -962,7 +982,11 @@ public static PdfFormXObject ConvertToXObject(Stream stream, PdfDocument documen
962982
/// using
963983
/// <see cref="iText.Kernel.Pdf.PdfObject.CopyTo(iText.Kernel.Pdf.PdfDocument)"/>.
964984
/// </remarks>
965-
/// <param name="stream">the Stream object containing valid SVG content</param>
985+
/// <param name="stream">
986+
/// the
987+
/// <see cref="System.IO.Stream">Stream</see>
988+
/// containing valid SVG content
989+
/// </param>
966990
/// <param name="document">
967991
/// the
968992
/// <see cref="iText.Kernel.Pdf.PdfDocument"/>
@@ -971,8 +995,7 @@ public static PdfFormXObject ConvertToXObject(Stream stream, PdfDocument documen
971995
/// <returns>
972996
/// a
973997
/// <see cref="iText.Layout.Element.Image">Image</see>
974-
/// containing the PDF instructions
975-
/// corresponding to the passed SVG content
998+
/// containing the PDF instructions corresponding to the passed SVG content
976999
/// </returns>
9771000
public static Image ConvertToImage(Stream stream, PdfDocument document) {
9781001
return new Image(ConvertToXObject(stream, document));
@@ -1012,7 +1035,7 @@ public static Image ConvertToImage(Stream stream, PdfDocument document) {
10121035
/// <param name="stream">
10131036
/// the
10141037
/// <see cref="System.IO.Stream">Stream</see>
1015-
/// object containing valid SVG content
1038+
/// containing valid SVG content
10161039
/// </param>
10171040
/// <param name="document">
10181041
/// the
@@ -1022,13 +1045,12 @@ public static Image ConvertToImage(Stream stream, PdfDocument document) {
10221045
/// <param name="props">
10231046
///
10241047
/// <see cref="iText.Svg.Processors.ISvgConverterProperties"/>
1025-
/// to customize the behavior
1048+
/// an instance for extra properties to customize the behavior
10261049
/// </param>
10271050
/// <returns>
10281051
/// a
10291052
/// <see cref="iText.Layout.Element.Image">Image</see>
1030-
/// containing the PDF instructions
1031-
/// corresponding to the passed SVG content
1053+
/// containing the PDF instructions corresponding to the passed SVG content
10321054
/// </returns>
10331055
public static Image ConvertToImage(Stream stream, PdfDocument document, ISvgConverterProperties props) {
10341056
return new Image(ConvertToXObject(stream, document, props));
@@ -1162,7 +1184,11 @@ private static PdfFormXObject ConvertToXObject(ISvgNodeRenderer topSvgRenderer,
11621184
/// The properties used by the processor are the
11631185
/// <see cref="iText.Svg.Processors.Impl.SvgConverterProperties"/>
11641186
/// </remarks>
1165-
/// <param name="svgStream">Input stream containing the SVG to parse and process</param>
1187+
/// <param name="svgStream">
1188+
///
1189+
/// <see cref="System.IO.Stream">Stream</see>
1190+
/// containing the SVG to parse and process
1191+
/// </param>
11661192
/// <returns>
11671193
///
11681194
/// <see cref="iText.Svg.Processors.ISvgProcessorResult"/>
@@ -1185,7 +1211,7 @@ public static ISvgProcessorResult ParseAndProcess(Stream svgStream) {
11851211
/// <param name="props">
11861212
///
11871213
/// <see cref="iText.Svg.Processors.ISvgConverterProperties"/>
1188-
/// used by the processor
1214+
/// an instance for extra properties to customize the behavior
11891215
/// </param>
11901216
/// <returns>
11911217
///
@@ -1234,7 +1260,7 @@ public static ISvgProcessorResult Process(INode root) {
12341260
/// <param name="props">
12351261
///
12361262
/// <see cref="iText.Svg.Processors.ISvgConverterProperties"/>
1237-
/// to customize the behavior
1263+
/// an instance for extra properties to customize the behavior
12381264
/// </param>
12391265
/// <returns>a node renderer tree corresponding to the passed XML DOM tree</returns>
12401266
public static ISvgProcessorResult Process(INode root, ISvgConverterProperties props) {
@@ -1266,7 +1292,7 @@ public static INode Parse(String content) {
12661292
/// <param name="stream">
12671293
/// the
12681294
/// <see cref="System.IO.Stream">Stream</see>
1269-
/// object containing valid SVG content
1295+
/// containing valid SVG content
12701296
/// </param>
12711297
/// <returns>an XML DOM tree corresponding to the passed String input</returns>
12721298
public static INode Parse(Stream stream) {
@@ -1292,12 +1318,12 @@ public static INode Parse(Stream stream) {
12921318
/// <param name="stream">
12931319
/// the
12941320
/// <see cref="System.IO.Stream">Stream</see>
1295-
/// object containing valid SVG content
1321+
/// containing valid SVG content
12961322
/// </param>
12971323
/// <param name="props">
12981324
///
12991325
/// <see cref="iText.Svg.Processors.ISvgConverterProperties"/>
1300-
/// to customize the behavior
1326+
/// an instance for extra properties to customize the behavior
13011327
/// </param>
13021328
/// <returns>an XML DOM tree corresponding to the passed String input</returns>
13031329
public static INode Parse(Stream stream, ISvgConverterProperties props) {
@@ -1394,7 +1420,11 @@ internal static ResourceResolver GetResourceResolver(ISvgProcessorResult process
13941420
/// Tries to extract charset from
13951421
/// <see cref="iText.Svg.Processors.ISvgConverterProperties"/>.
13961422
/// </summary>
1397-
/// <param name="props">converter properties</param>
1423+
/// <param name="props">
1424+
///
1425+
/// <see cref="iText.Svg.Processors.ISvgConverterProperties"/>
1426+
/// an instance for extra properties to customize the behavior
1427+
/// </param>
13981428
/// <returns>charset | null</returns>
13991429
private static String TryToExtractCharset(ISvgConverterProperties props) {
14001430
return props != null ? props.GetCharset() : null;

‎port-hash

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
134882705ad622a26c22ec85d11d8937d2593029
1+
075fb5390c140ce7710427fbbb526115706d61ef

0 commit comments

Comments
 (0)