Skip to content

Commit 0ce78fb

Browse files
Egor MartsynkovskyUbuntu
authored andcommitted
Refactor class documentation
1 parent aaf9dee commit 0ce78fb

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

kernel/src/main/java/com/itextpdf/kernel/utils/PdfSplitter.java

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,11 +113,12 @@ public void setPreserveOutlines(boolean preserveOutlines) {
113113
}
114114

115115
/**
116-
* Splits the document basing on the given size.
116+
* Splits the document basing on the given size specified in bytes.
117+
*
118+
* @param size <strong>Preferred</strong> size specified in bytes for splitting.
117119
*
118-
* @param size <strong>Preferred</strong> size for splitting.
119120
* @return The documents which the source document was split into.
120-
* Be warned that these documents are not closed.
121+
* Be warned that these documents are not closed.
121122
*/
122123
public List<PdfDocument> splitBySize(long size) {
123124
List<PageRange> splitRanges = new ArrayList<>();
@@ -196,6 +197,7 @@ public void splitByPageCount(int pageCount, IDocumentReadyListener documentReady
196197
* Splits a document into smaller documents with no more than @pageCount pages each.
197198
*
198199
* @param pageCount the biggest possible number of pages in a split document.
200+
*
199201
* @return the list of resultant documents. By warned that they are not closed.
200202
*/
201203
public List<PdfDocument> splitByPageCount(int pageCount) {
@@ -210,6 +212,7 @@ public List<PdfDocument> splitByPageCount(int pageCount) {
210212
* Extracts the specified page ranges from a document.
211213
*
212214
* @param pageRanges the list of page ranges for each of the resultant document.
215+
*
213216
* @return the list of the resultant documents for each of the specified page range.
214217
* Be warned that these documents are not closed.
215218
*/
@@ -229,6 +232,7 @@ public List<PdfDocument> extractPageRanges(List<PageRange> pageRanges) {
229232
* Extracts the specified page ranges from a document.
230233
*
231234
* @param pageRange the page range to be extracted from the document.
235+
*
232236
* @return the resultant document containing the pages specified by the provided page range.
233237
* Be warned that this document is not closed.
234238
*/
@@ -244,7 +248,9 @@ public PdfDocument getPdfDocument() {
244248
* This method is called when another split document is to be created.
245249
* You can override this method and return your own {@link PdfWriter} depending on your needs.
246250
*
247-
* @param documentPageRange the page range of the original document to be included in the document being created now.
251+
* @param documentPageRange the page range of the original document to be included
252+
* in the document being created now.
253+
*
248254
* @return the PdfWriter instance for the document which is being created.
249255
*/
250256
protected PdfWriter getNextPdfWriter(PageRange documentPageRange) {
@@ -269,6 +275,7 @@ public interface IDocumentReadyListener {
269275
* and places the entire hierarchy in a separate document ( outlines and pages ) .
270276
*
271277
* @param outlineTitles list of outline titles .
278+
*
272279
* @return Collection of {@link PdfDocument} which contains split parts of a document
273280
*/
274281
public List<PdfDocument> splitByOutlines(List<String> outlineTitles) {

0 commit comments

Comments
 (0)