Skip to content
This repository was archived by the owner on Jul 31, 2022. It is now read-only.

Commit 679af05

Browse files
committed
Corrected documentation typos
1 parent 85bcb58 commit 679af05

1 file changed

Lines changed: 36 additions & 20 deletions

File tree

src/ktt/lib/httpserver/handler/FileHandler.java

Lines changed: 36 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ public final void addFile(final File file, final String fileName){
130130
/**
131131
* Adds a file to the handler and preloads the bytes.
132132
*
133-
* @param file file to use
133+
* @param file file to add
134134
* @param fileName file name to use
135135
* @param preload whether to load the bytes now or at the exchange
136136
*
@@ -153,7 +153,7 @@ public final void addFile(final File file, final String fileName, final boolean
153153
* Adds a file to the handler at a specified context at a name given by the adapter.
154154
*
155155
* @param context context to use
156-
* @param file file to use
156+
* @param file file to add
157157
*
158158
* @see FileHandlerAdapter
159159
* @see #addFile(File)
@@ -174,8 +174,8 @@ public final void addFile(final String context, final File file){
174174
* Adds a file to the handler at a specified context at a name given by the adapter and preloads the bytes.
175175
*
176176
* @param context context to use
177-
* @param file file to use
178-
* @param preload whether to load the bytes not or at the exchange
177+
* @param file file to add
178+
* @param preload whether to load the bytes now or at the exchange
179179
*
180180
* @see FileHandlerAdapter
181181
* @see #addFile(File)
@@ -196,7 +196,7 @@ public final void addFile(final String context, final File file, final boolean p
196196
* Adds a file to the handler at a specified context.
197197
*
198198
* @param context context to use
199-
* @param file file to use
199+
* @param file file to add
200200
* @param fileName file name to use
201201
*
202202
* @see FileHandlerAdapter
@@ -218,7 +218,7 @@ public final void addFile(final String context, final File file, final String fi
218218
* Adds a file to the handler at a specified context and preloads the bytes.
219219
*
220220
* @param context context to use
221-
* @param file file to use
221+
* @param file file to add
222222
* @param fileName file name to use
223223
* @param preload whether to load the bytes now or at the exchange.
224224
*
@@ -246,6 +246,7 @@ public final void addFile(final String context, final File file, final String fi
246246
*
247247
* @param files files to add
248248
*
249+
* @see FileHandlerAdapter
249250
* @see #addFiles(File[], boolean)
250251
* @see #addFiles(String, File[])
251252
* @see #addFiles(String, File[], boolean)
@@ -263,6 +264,7 @@ public final void addFiles(final File[] files){
263264
* @param files files to add
264265
* @param preload whether to load the bytes now or at the exchange
265266
*
267+
* @see FileHandlerAdapter
266268
* @see #addFiles(File[])
267269
* @see #addFiles(String, File[])
268270
* @see #addFiles(String, File[], boolean)
@@ -280,6 +282,7 @@ public final void addFiles(final File[] files, final boolean preload){
280282
* @param context context to use
281283
* @param files files to add
282284
*
285+
* @see FileHandlerAdapter
283286
* @see #addFiles(File[])
284287
* @see #addFiles(File[], boolean)
285288
* @see #addFiles(String, File[], boolean)
@@ -298,6 +301,7 @@ public final void addFiles(final String context, final File[] files){
298301
* @param files files to add
299302
* @param preload whether to read the bytes now or at the exchange
300303
*
304+
* @see FileHandlerAdapter
301305
* @see #addFiles(File[])
302306
* @see #addFiles(File[], boolean)
303307
* @see #addFiles(String, File[])
@@ -306,7 +310,7 @@ public final void addFiles(final String context, final File[] files){
306310
*/
307311
public final void addFiles(final String context, final File[] files, final boolean preload){
308312
for(final File file : files)
309-
addFile(context,file);
313+
addFile(context,file,preload);
310314
}
311315

312316
//
@@ -316,6 +320,7 @@ public final void addFiles(final String context, final File[] files, final boole
316320
*
317321
* @param directory directory to add
318322
*
323+
* @see FileHandlerAdapter
319324
* @see #addDirectory(File, boolean)
320325
* @see #addDirectory(File, boolean, boolean)
321326
* @see #addDirectory(File, String)
@@ -337,7 +342,8 @@ public final void addDirectory(final File directory){
337342
/**
338343
* Adds a directory to the handler and preloads the files' bytes.
339344
*
340-
* @param directory directory to use
345+
* @see FileHandlerAdapter
346+
* @param directory directory to add
341347
* @param preload whether to read the bytes now or at the exchange
342348
*
343349
* @see #addDirectory(File)
@@ -361,9 +367,10 @@ public final void addDirectory(final File directory, final boolean preload){
361367
/**
362368
* Adds a directory and all its inner folders to the handler and preloads the files' bytes.
363369
*
364-
* @param directory directory to use
370+
* @see FileHandlerAdapter
371+
* @param directory directory to add
365372
* @param preload whether to read the bytes now or at the exchange
366-
* @param walk whether to use inner folders or not
373+
* @param walk whether to use the inner directories or not
367374
*
368375
* @see #addDirectory(File)
369376
* @see #addDirectory(File, boolean)
@@ -386,7 +393,8 @@ public final void addDirectory(final File directory, final boolean preload, fina
386393
/**
387394
* Adds a directory with a specified name to the handler.
388395
*
389-
* @param directory directory to use
396+
* @see FileHandlerAdapter
397+
* @param directory directory to add
390398
* @param directoryName directory name
391399
*
392400
* @see #addDirectory(File)
@@ -410,10 +418,11 @@ public final void addDirectory(final File directory, final String directoryName)
410418
/**
411419
* Adds a directory with a specified name to the handler and preloads the bytes.
412420
*
413-
* @param directory directory to use
421+
* @param directory directory to add
414422
* @param directoryName directory name
415423
* @param preload whether to read the bytes now or at the exchange
416424
*
425+
* @see FileHandlerAdapter
417426
* @see #addDirectory(File)
418427
* @see #addDirectory(File, boolean)
419428
* @see #addDirectory(File, boolean, boolean)
@@ -435,11 +444,12 @@ public final void addDirectory(final File directory, final String directoryName,
435444
/**
436445
* Adds a directory with a specified name to the handler and all its inner folders and preloads the bytes.
437446
*
438-
* @param directory directory to use
447+
* @param directory directory to add
439448
* @param directoryName directory name
440449
* @param preload whether to read the bytes now or at the exchange
441-
* @param walk whether to use inner folders or not
450+
* @param walk whether to use the inner directories or not
442451
*
452+
* @see FileHandlerAdapter
443453
* @see #addDirectory(File)
444454
* @see #addDirectory(File, boolean)
445455
* @see #addDirectory(File, boolean, boolean)
@@ -464,6 +474,7 @@ public final void addDirectory(final File directory, final String directoryName,
464474
* @param context context to use
465475
* @param directory directory to add
466476
*
477+
* @see FileHandlerAdapter
467478
* @see #addDirectory(File)
468479
* @see #addDirectory(File, boolean)
469480
* @see #addDirectory(File, boolean, boolean)
@@ -489,6 +500,7 @@ public final void addDirectory(final String context, final File directory){
489500
* @param directory directory to add
490501
* @param preload whether to read the bytes now or at the exchange
491502
*
503+
* @see FileHandlerAdapter
492504
* @see #addDirectory(File)
493505
* @see #addDirectory(File, boolean)
494506
* @see #addDirectory(File, boolean, boolean)
@@ -511,10 +523,11 @@ public final void addDirectory(final String context, final File directory, final
511523
* Adds a directory at a specified context and its inner folders and preloads the bytes.
512524
*
513525
* @param context context to use
514-
* @param directory directory to use
526+
* @param directory directory to add
515527
* @param preload whether to read the bytes now or at the exchange
516-
* @param walk whether to use inner folders or not
528+
* @param walk whether to use the inner directories or not`
517529
*
530+
* @see FileHandlerAdapter
518531
* @see #addDirectory(File)
519532
* @see #addDirectory(File, boolean)
520533
* @see #addDirectory(File, boolean, boolean)
@@ -537,9 +550,10 @@ public final void addDirectory(final String context, final File directory, final
537550
* Adds a directory at a specified context with a specified name.
538551
*
539552
* @param context context to use
540-
* @param directory directory to use
553+
* @param directory directory to add
541554
* @param directoryName directory name
542555
*
556+
* @see FileHandlerAdapter
543557
* @see #addDirectory(File)
544558
* @see #addDirectory(File, boolean)
545559
* @see #addDirectory(File, boolean, boolean)
@@ -562,10 +576,11 @@ public final void addDirectory(final String context, final File directory, final
562576
* Adds a directory at a specified context with a specified name and preloads the bytes.
563577
*
564578
* @param context context to use
565-
* @param directory directory to use
579+
* @param directory directory to add
566580
* @param directoryName directory name
567581
* @param preload whether to read the bytes now or at the exchange
568582
*
583+
* @see FileHandlerAdapter
569584
* @see #addDirectory(File)
570585
* @see #addDirectory(File, boolean)
571586
* @see #addDirectory(File, boolean, boolean)
@@ -588,11 +603,12 @@ public final void addDirectory(final String context, final File directory, final
588603
* Adds a directory at a specified context with a specified name and all its inner folders and preloads the bytes.
589604
*
590605
* @param context context to use
591-
* @param directory directory to use
606+
* @param directory directory to add
592607
* @param directoryName directory name
593608
* @param preload whether to read the bytes now or at the exchange
594-
* @param walk whether to use the inner folders or not
609+
* @param walk whether to use the inner directories or not
595610
*
611+
* @see FileHandlerAdapter
596612
* @see #addDirectory(File)
597613
* @see #addDirectory(File, boolean)
598614
* @see #addDirectory(File, boolean, boolean)

0 commit comments

Comments
 (0)