forked from openjdk/jdk
/
BaseOptions.java
1138 lines (993 loc) · 36.8 KB
/
BaseOptions.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package jdk.javadoc.internal.doclets.toolkit;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.MissingResourceException;
import java.util.Set;
import java.util.StringTokenizer;
import java.util.TreeSet;
import jdk.javadoc.doclet.Doclet;
import jdk.javadoc.doclet.Reporter;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
import static javax.tools.Diagnostic.Kind.ERROR;
/**
* Storage for the format-independent options supported by the toolkit.
* The objects to handle command-line options, and to initialize this
* object, are all subtypes of {@link BaseOptions.Option},
* returned by {@link BaseOptions#getSupportedOptions()}.
*
* <p>Some of the methods used to access the values of options
* have names that begin with a verb, such as {@link #copyDocfileSubdirs}
* or {@link #showVersion}. Unless otherwise stated,
* these methods should all be taken as just accessing the value
* of the associated option.
*/
public abstract class BaseOptions {
//<editor-fold desc="Option values">
/**
* Argument for command-line option {@code --allow-script-in-comments}.
* Allow JavaScript in doc comments.
*/
private boolean allowScriptInComments = false;
/**
* Argument for command-line option {@code -docfilessubdirs}.
* True if we should recursively copy the doc-file subdirectories
*/
private boolean copyDocfileSubdirs = false;
/**
* Arguments for command-line option {@code -tag} and {@code -taglet}.
*/
private final LinkedHashSet<List<String>> customTagStrs = new LinkedHashSet<>();
/**
* Argument for command-line option {@code -d}.
* Destination directory name, in which doclet will generate the entire
* documentation. Default is current directory.
*/
private String destDirName = "";
/**
* Argument for command-line option {@code --disable-javafx-strict-checks}.
* Primarily used to disable strict checks in the regression
* tests allowing those tests to be executed successfully, for
* instance, with OpenJDK builds which may not contain FX libraries.
*/
private boolean disableJavaFxStrictChecks = false;
/**
* Argument for command-line option {@code -docencoding}.
* Encoding for this document. Default is default encoding for this
* platform.
*/
private String docEncoding = null;
/**
* Argument for command-line option {@code ???}.
* Destination directory name, in which doclet will copy the doc-files to.
*/
private String docFileDestDirName = "";
/**
* Argument for hidden command-line option {@code --dump-on-error}.
*/
private boolean dumpOnError = false;
/**
* Argument for command-line option {@code -encoding}.
* Encoding for this document. Default is default encoding for this
* platform.
*/
private String encoding = null;
/**
* Argument for command-line option {@code -excludedocfilessubdir}.
* The set of doc-file subdirectories to exclude.
*/
private Set<String> excludedDocFileDirs;
/**
* Argument for command-line option {@code -noqualifier}.
* The set of qualifiers to exclude.
*/
private Set<String> excludedQualifiers;
/**
* Arguments for command-line option {@code -group}
*/
private List<Utils.Pair<String, String>> groupPairs;
/**
* Argument for command-line option {@code --javafx} or {@code -javafx}.
* Generate documentation for JavaFX getters and setters automatically
* by copying it from the appropriate property definition.
*/
private boolean javafx = false;
/**
* Argument for command-line option {@code -keywords}.
* True if user wants to add member names as meta keywords.
* Set to false because meta keywords are ignored in general
* by most Internet search engines.
*/
private boolean keywords = false;
/**
* Arguments for command-line option {@code -link}.
*/
// A list containing urls
private final List<String> linkList = new ArrayList<>();
/**
* Arguments for command-line option {@code -linkoffline}.
*/
// A list of pairs containing urls and package list
private final List<Utils.Pair<String, String>> linkOfflineList = new ArrayList<>();
/**
* Argument for command-line option {@code --link-modularity-mismatch}.
* True if warnings on external documentation with non-matching modularity should be omitted.
*/
private boolean linkModularityNoWarning = false;
/**
* Location of alternative platform link properties file.
*/
private String linkPlatformProperties;
/**
* Argument for command-line option {@code -linksource}.
* True if we should generate browsable sources.
*/
private boolean linkSource = false;
/**
* Argument for command-line option {@code -nocomment}.
* True if user wants to suppress descriptions and tags.
*/
private boolean noComment = false;
/**
* Argument for command-line option {@code -nodeprecated}.
* Don't generate deprecated API information at all, if -nodeprecated
* option is used. <code>nodeprecated</code> is set to true if
* -nodeprecated option is used. Default is generate deprecated API
* information.
*/
private boolean noDeprecated = false;
/**
* Argument for command-line option {@code --no-platform-links}.
* True if command-line option "--no-platform-links" is used. Default value is
* false.
*/
private boolean noPlatformLinks = false;
/**
* Argument for command-line option {@code -nosince}.
* True if command-line option "-nosince" is used. Default value is
* false.
*/
private boolean noSince = false;
/**
* Argument for command-line option {@code -notimestamp}.
* True if user wants to suppress time stamp in output.
* Default is false.
*/
private boolean noTimestamp = false;
/**
* Argument for command-line option {@code -quiet}.
* Suppress all messages
*/
private boolean quiet = false;
/**
* Argument for command-line option {@code -serialwarn}.
* This is true if option "-serialwarn" is used. Default value is false to
* suppress excessive warnings about serial tag.
*/
private boolean serialWarn = false;
/**
* Argument for command-line option {@code -author}.
* Generate author specific information for all the classes if @author
* tag is used in the doc comment and if -author option is used.
* <code>showauthor</code> is set to true if -author option is used.
* Default is don't show author information.
*/
private boolean showAuthor = false;
/**
* Argument for command-line option {@code --show-taglets}.
* Show taglets (internal debug switch)
*/
private boolean showTaglets = false;
/**
* Argument for command-line option {@code -version}.
* Generate version specific information for the all the classes
* if @version tag is used in the doc comment and if -version option is
* used. {@code showVersion} is set to true if -version option is
* used. Default is don't show version information.
*/
private boolean showVersion = false;
/**
* Argument for command line option {@code --since}.
* Specifies a list of release names for which to document API changes.
*/
private List<String> since = List.of();
/**
* Argument for command line option {@code --since-label}.
* Specifies custom text to use as heading of New API page.
*/
private String sinceLabel;
/**
* Argument for command-line option {@code -sourcetab}.
* The specified amount of space between tab stops.
*/
private int sourceTabSize;
/**
* Value for command-line option {@code --override-methods summary}
* or {@code --override-methods detail}.
* Specifies whether those methods that override a super-type's method
* with no changes to the API contract should be summarized in the
* footnote section.
*/
private boolean summarizeOverriddenMethods = false;
/**
* Argument for command-line option {@code -tagletpath}.
* The path to Taglets
*/
private String tagletPath = null;
/**
* Argument for command-line option {@code --snippet-path}.
* The path for external snippets.
*/
private String snippetPath = null;
//</editor-fold>
private final BaseConfiguration config;
protected BaseOptions(BaseConfiguration config) {
this.config = config;
excludedDocFileDirs = new HashSet<>();
excludedQualifiers = new HashSet<>();
sourceTabSize = DocletConstants.DEFAULT_TAB_STOP_LENGTH;
groupPairs = new ArrayList<>(0);
}
public Set<? extends Option> getSupportedOptions() {
Resources resources = config.getDocResources();
Messages messages = config.getMessages();
Reporter reporter = config.getReporter();
List<Option> options = List.of(
new Option(resources, "-author") {
@Override
public boolean process(String opt, List<String> args) {
showAuthor = true;
return true;
}
},
new Option(resources, "-d", 1) {
@Override
public boolean process(String opt, List<String> args) {
destDirName = addTrailingFileSep(args.get(0));
return true;
}
},
new Option(resources, "-docencoding", 1) {
@Override
public boolean process(String opt, List<String> args) {
docEncoding = args.get(0);
return true;
}
},
new Option(resources, "-docfilessubdirs") {
@Override
public boolean process(String opt, List<String> args) {
copyDocfileSubdirs = true;
return true;
}
},
new Hidden(resources, "-encoding", 1) {
@Override
public boolean process(String opt, List<String> args) {
encoding = args.get(0);
return true;
}
},
new Option(resources, "-excludedocfilessubdir", 1) {
@Override
public boolean process(String opt, List<String> args) {
addToSet(excludedDocFileDirs, args.get(0));
return true;
}
},
new Option(resources, "-group", 2) {
@Override
public boolean process(String opt, List<String> args) {
groupPairs.add(new Utils.Pair<>(args.get(0), args.get(1)));
return true;
}
},
new Option(resources, "--javafx -javafx") {
@Override
public boolean process(String opt, List<String> args) {
javafx = true;
return true;
}
},
new Option(resources, "-keywords") {
@Override
public boolean process(String opt, List<String> args) {
keywords = true;
return true;
}
},
new Option(resources, "-link", 1) {
@Override
public boolean process(String opt, List<String> args) {
linkList.add(args.get(0));
return true;
}
},
new Option(resources, "-linksource") {
@Override
public boolean process(String opt, List<String> args) {
linkSource = true;
return true;
}
},
new Option(resources, "-linkoffline", 2) {
@Override
public boolean process(String opt, List<String> args) {
linkOfflineList.add(new Utils.Pair<>(args.get(0), args.get(1)));
return true;
}
},
new Option(resources, "--link-modularity-mismatch", 1) {
@Override
public boolean process(String opt, List<String> args) {
String s = args.get(0);
switch (s) {
case "warn" -> linkModularityNoWarning = false;
case "info" -> linkModularityNoWarning = true;
default -> {
reporter.print(ERROR, resources.getText(
"doclet.Option_invalid", s, "--link-modularity-mismatch"));
return false;
}
}
return true;
}
},
new Option(resources, "--link-platform-properties", 1) {
@Override
public boolean process(String opt, List<String> args) {
linkPlatformProperties = args.get(0);
return true;
}
},
new Option(resources, "-nocomment") {
@Override
public boolean process(String opt, List<String> args) {
noComment = true;
return true;
}
},
new Option(resources, "-nodeprecated") {
@Override
public boolean process(String opt, List<String> args) {
noDeprecated = true;
return true;
}
},
new Option(resources, "-nosince") {
@Override
public boolean process(String opt, List<String> args) {
noSince = true;
return true;
}
},
new Option(resources, "-notimestamp") {
@Override
public boolean process(String opt, List<String> args) {
noTimestamp = true;
return true;
}
},
new Option(resources, "-noqualifier", 1) {
@Override
public boolean process(String opt, List<String> args) {
addToSet(excludedQualifiers, args.get(0));
return true;
}
},
new Option(resources, "--no-platform-links") {
@Override
public boolean process(String opt, List<String> args) {
noPlatformLinks = true;
return true;
}
},
new Option(resources, "--override-methods", 1) {
@Override
public boolean process(String opt, List<String> args) {
String o = args.get(0);
switch (o) {
case "summary" -> summarizeOverriddenMethods = true;
case "detail" -> summarizeOverriddenMethods = false;
default -> {
reporter.print(ERROR,
resources.getText("doclet.Option_invalid",o, "--override-methods"));
return false;
}
}
return true;
}
},
new Hidden(resources, "-quiet") {
@Override
public boolean process(String opt, List<String> args) {
quiet = true;
return true;
}
},
new Option(resources, "-serialwarn") {
@Override
public boolean process(String opt, List<String> args) {
serialWarn = true;
return true;
}
},
new Option(resources, "--since", 1) {
@Override
public boolean process(String opt, List<String> args) {
since = Arrays.stream(args.get(0).split(",")).map(String::trim).toList();
return true;
}
},
new Option(resources, "--since-label", 1) {
@Override
public boolean process(String opt, List<String> args) {
sinceLabel = args.get(0);
return true;
}
},
new Option(resources, "-sourcetab", 1) {
@Override
public boolean process(String opt, List<String> args) {
linkSource = true;
try {
sourceTabSize = Integer.parseInt(args.get(0));
} catch (NumberFormatException e) {
//Set to -1 so that warning will be printed
//to indicate what is valid argument.
sourceTabSize = -1;
}
if (sourceTabSize <= 0) {
messages.warning("doclet.sourcetab_warning");
sourceTabSize = DocletConstants.DEFAULT_TAB_STOP_LENGTH;
}
return true;
}
},
new Option(resources, "-tag", 1) {
@Override
public boolean process(String opt, List<String> args) {
ArrayList<String> list = new ArrayList<>();
list.add(opt);
list.add(args.get(0));
customTagStrs.add(list);
return true;
}
},
new Option(resources, "-taglet", 1) {
@Override
public boolean process(String opt, List<String> args) {
ArrayList<String> list = new ArrayList<>();
list.add(opt);
list.add(args.get(0));
customTagStrs.add(list);
return true;
}
},
new Option(resources, "-tagletpath", 1) {
@Override
public boolean process(String opt, List<String> args) {
tagletPath = args.get(0);
return true;
}
},
new Option(resources, "--snippet-path", 1) {
@Override
public boolean process(String opt, List<String> args) {
snippetPath = args.get(0);
return true;
}
},
new Option(resources, "-version") {
@Override
public boolean process(String opt, List<String> args) {
showVersion = true;
return true;
}
},
new Hidden(resources, "--dump-on-error") {
@Override
public boolean process(String opt, List<String> args) {
dumpOnError = true;
return true;
}
},
new Option(resources, "--allow-script-in-comments") {
@Override
public boolean process(String opt, List<String> args) {
allowScriptInComments = true;
return true;
}
},
new Hidden(resources, "--disable-javafx-strict-checks") {
@Override
public boolean process(String opt, List<String> args) {
disableJavaFxStrictChecks = true;
return true;
}
},
new Hidden(resources, "--show-taglets") {
@Override
public boolean process(String opt, List<String> args) {
showTaglets = true;
return true;
}
}
);
return new TreeSet<>(options);
}
/**
* This checks for the validity of the options used by the user.
* As of this writing, this checks only docencoding.
*
* @return true if all the options are valid.
*/
protected boolean generalValidOptions() {
if (docEncoding != null) {
if (!checkOutputFileEncoding(docEncoding)) {
return false;
}
}
if (docEncoding == null && (encoding != null && !encoding.isEmpty())) {
if (!checkOutputFileEncoding(encoding)) {
return false;
}
}
return true;
}
/**
* Check the validity of the given Source or Output File encoding on this
* platform.
*
* @param docencoding output file encoding.
*/
private boolean checkOutputFileEncoding(String docencoding) {
OutputStream ost = new ByteArrayOutputStream();
OutputStreamWriter osw = null;
try {
osw = new OutputStreamWriter(ost, docencoding);
} catch (UnsupportedEncodingException exc) {
config.reporter.print(ERROR,
config.getDocResources().getText("doclet.Encoding_not_supported", docencoding));
return false;
} finally {
try {
if (osw != null) {
osw.close();
}
} catch (IOException exc) {
}
}
return true;
}
private void addToSet(Set<String> s, String str) {
StringTokenizer st = new StringTokenizer(str, ":");
String current;
while (st.hasMoreTokens()) {
current = st.nextToken();
s.add(current);
}
}
/**
* Add a trailing file separator, if not found. Remove superfluous
* file separators if any. Preserve the front double file separator for
* UNC paths.
*
* @param path Path under consideration.
* @return String Properly constructed path string.
*/
protected static String addTrailingFileSep(String path) {
String fs = System.getProperty("file.separator");
String dblfs = fs + fs;
int indexDblfs;
while ((indexDblfs = path.indexOf(dblfs, 1)) >= 0) {
path = path.substring(0, indexDblfs) +
path.substring(indexDblfs + fs.length());
}
if (!path.endsWith(fs))
path += fs;
return path;
}
/**
* Argument for command-line option {@code --allow-script-in-comments}.
* Allow JavaScript in doc comments.
*/
boolean allowScriptInComments() {
return allowScriptInComments;
}
/**
* Argument for command-line option {@code -docfilessubdirs}.
* True if we should recursively copy the doc-file subdirectories
*/
public boolean copyDocfileSubdirs() {
return copyDocfileSubdirs;
}
/**
* Arguments for command-line option {@code -tag} and {@code -taglet}.
*/
LinkedHashSet<List<String>> customTagStrs() {
return customTagStrs;
}
/**
* Argument for command-line option {@code -d}.
* Destination directory name, in which doclet will generate the entire
* documentation. Default is current directory.
*/
String destDirName() {
return destDirName;
}
/**
* Argument for command-line option {@code --disable-javafx-strict-checks}.
* Primarily used to disable strict checks in the regression
* tests allowing those tests to be executed successfully, for
* instance, with OpenJDK builds which may not contain FX libraries.
*/
boolean disableJavaFxStrictChecks() {
return disableJavaFxStrictChecks;
}
/**
* Argument for command-line option {@code -docencoding}.
* Encoding for this document. Default is default encoding for this
* platform.
*/
public String docEncoding() {
return docEncoding;
}
public void setDocEncoding(String docEncoding) {
this.docEncoding = docEncoding;
}
/**
* Argument for command-line option {@code ???}.
* Destination directory name, in which doclet will copy the doc-files to.
*/
String docFileDestDirName() {
return docFileDestDirName;
}
/**
* Argument for hidden command-line option {@code --dump-on-error}.
*/
boolean dumpOnError() {
return dumpOnError;
}
/**
* Argument for command-line option {@code -encoding}.
* Encoding for this document. Default is default encoding for this
* platform.
*/
public String encoding() {
return encoding;
}
/**
* Argument for command-line option {@code -excludedocfilessubdir}.
* The set of doc-file subdirectories to exclude.
*/
Set<String> excludedDocFileDirs() {
return excludedDocFileDirs;
}
/**
* Argument for command-line option {@code -noqualifier}.
* The set of qualifiers to exclude.
*/
Set<String> excludedQualifiers() {
return excludedQualifiers;
}
/**
* Arguments for command-line option {@code -group}
*/
List<Utils.Pair<String, String>> groupPairs() {
return groupPairs;
}
/**
* Argument for command-line option {@code --javafx} or {@code -javafx}.
* Generate documentation for JavaFX getters and setters automatically
* by copying it from the appropriate property definition.
*/
public boolean javafx() {
return javafx;
}
public void setJavaFX(boolean javafx) {
this.javafx = javafx;
}
/**
* Argument for command-line option {@code -keywords}.
* True if user wants to add member names as meta keywords.
* Set to false because meta keywords are ignored in general
* by most Internet search engines.
*/
public boolean keywords() {
return keywords;
}
/**
* Arguments for command-line option {@code -link}.
*/
List<String> linkList() {
return linkList;
}
/**
* Arguments for command-line option {@code -linkoffline}.
*/
List<Utils.Pair<String, String>> linkOfflineList() {
return linkOfflineList;
}
/**
* Argument for command-line option {@code --link-modularity-mismatch}.
* True if warnings on external documentation with non-matching modularity
* should be omitted.
*/
public boolean linkModularityNoWarning() {
return linkModularityNoWarning;
}
/**
* Argument for command-line option {@code --link-platform-properties}.
*/
String linkPlatformProperties() {
return linkPlatformProperties;
}
/**
* Argument for command-line option {@code -linksource}.
* True if we should generate browsable sources.
*/
public boolean linkSource() {
return linkSource;
}
/**
* Argument for command-line option {@code -nocomment}.
* True if user wants to suppress descriptions and tags.
*/
public boolean noComment() {
return noComment;
}
/**
* Argument for command-line option {@code -nodeprecated}.
* Don't generate deprecated API information at all if -nodeprecated
* option is used. {@code noDeprecated} is set to {@code true} if
* {@code -nodeprecated} option is used.
* Default is generate deprecated API information.
*/
public boolean noDeprecated() {
return noDeprecated;
}
/**
* Argument for command-line option {@code --no-platform-links}.
* True if command-line option {@code --no-platform-links"} is used.
* Default value is false.
*/
public boolean noPlatformLinks() {
return noPlatformLinks;
}
/**
* Argument for command-line option {@code -nosince}.
* True if command-line option {@code -nosince"} is used.
* Default value is false.
*/
public boolean noSince() {
return noSince;
}
/**
* Argument for command-line option {@code -notimestamp}.
* True if user wants to suppress time stamp in output.
* Default is false.
*/
public boolean noTimestamp() {
return noTimestamp;
}
/**
* Argument for command-line option {@code -quiet}.
* Suppress all messages
*/
boolean quiet() {
return quiet;
}
/**
* Argument for command-line option {@code -serialwarn}.
* This is true if option "-serialwarn" is used. Default value is false to
* suppress excessive warnings about serial tag.
*/
public boolean serialWarn() {
return serialWarn;
}
/**
* Argument for command-line option {@code -author}.
* Generate author specific information for all the classes if @author
* tag is used in the doc comment and if -author option is used.
* <code>showauthor</code> is set to true if -author option is used.
* Default is don't show author information.
*/
public boolean showAuthor() {
return showAuthor;
}
/**
* Argument for command-line option {@code --show-taglets}.
* Show taglets (internal debug switch)
*/
public boolean showTaglets() {
return showTaglets;
}
/**
* Argument for command-line option {@code -version}.
* Generate version specific information for the all the classes
* if @version tag is used in the doc comment and if -version option is
* used. {@code showVersion} is set to true if -version option is
* used. Default is don't show version information.
*/
public boolean showVersion() {
return showVersion;
}
/**
* Arguments for command line option {@code --since}.
*/
public List<String> since() {
return Collections.unmodifiableList(since);
}
/**
* Arguments for command line option {@code --since-label}.
*/
public String sinceLabel() {
return sinceLabel;
}
/**
* Argument for command-line option {@code -sourcetab}.
* The specified amount of space between tab stops.
*/
public int sourceTabSize() {
return sourceTabSize;
}
/**
* Value for command-line option {@code --override-methods summary}
* or {@code --override-methods detail}.
* Specifies whether those methods that override a super-type's method
* with no changes to the API contract should be summarized in the
* footnote section.
*/
public boolean summarizeOverriddenMethods() {
return summarizeOverriddenMethods;
}
/**