src/jdk.javadoc/share/classes/com/sun/tools/javadoc/resources/javadoc.properties
author goetz
Tue, 16 Jan 2018 08:48:34 +0100
changeset 48543 7067fe4e054e
parent 47702 cf8310446245
permissions -rw-r--r--
8189102: All tools should support -?, -h and --help Reviewed-by: kvn, jjg, weijun, alanb, rfield, ksrini
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
#
48543
7067fe4e054e 8189102: All tools should support -?, -h and --help
goetz
parents: 47702
diff changeset
     2
# Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
#
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
# This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
# under the terms of the GNU General Public License version 2 only, as
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
     7
# published by the Free Software Foundation.  Oracle designates this
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
# particular file as subject to the "Classpath" exception as provided
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
     9
# by Oracle in the LICENSE file that accompanied this code.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
#
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
# This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
# version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
# accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
#
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
# You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
# 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    19
# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    20
#
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    21
# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    22
# or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    23
# questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
#
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
main.errors={0} errors
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
main.error={0} error
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
main.warnings={0} warnings
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
main.warning={0} warning
18005
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    30
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    31
main.usage=Usage: javadoc [options] [packagenames] [sourcefiles] [@files]\n\
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    32
\  -overview <file>                 Read overview documentation from HTML file\n\
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    33
\  -public                          Show only public classes and members\n\
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    34
\  -protected                       Show protected/public classes and members (default)\n\
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    35
\  -package                         Show package/protected/public classes and members\n\
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    36
\  -private                         Show all classes and members\n\
48543
7067fe4e054e 8189102: All tools should support -?, -h and --help
goetz
parents: 47702
diff changeset
    37
\  --help                           Display command line options and exit\n\
18005
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    38
\  -doclet <class>                  Generate output via alternate doclet\n\
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    39
\  -docletpath <path>               Specify where to find doclet class files\n\
40308
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    40
\  --module-source-path <path>      Specify where to find input source files for multiple modules\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    41
\  --upgrade-module-path <path>     Override location of upgradeable modules\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    42
\  --module-path <path>, -p <path>  Specify where to find application modules\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    43
\  --add-modules <module>(,<module>)*\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    44
\                                   Root modules to resolve in addition to the initial modules,\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    45
\                                   or all modules on the module path if <module> is ALL-MODULE-PATH.\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    46
\  --limit-modules <module>(,<module>)*\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    47
\                                   Limit the universe of observable modules\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    48
\  --source-path <path>             Specify where to find source files\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    49
\  -sourcepath <path>               Specify where to find source files\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    50
\  --class-path <path>              Specify where to find user class files\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    51
\  -classpath <path>                Specify where to find user class files\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    52
\  -cp <path>                       Specify where to find user class files\n\
18005
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    53
\  -exclude <pkglist>               Specify a list of packages to exclude\n\
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    54
\  -subpackages <subpkglist>        Specify subpackages to recursively load\n\
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    55
\  -breakiterator                   Compute first sentence with BreakIterator\n\
40308
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    56
\  -bootclasspath <path>            Override location of platform class files\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    57
\                                   used for non-modular releases\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    58
\  --system <jdk>                   Override location of system modules used\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    59
\                                   for modular releases.\n\
18005
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    60
\  -source <release>                Provide source compatibility with specified release\n\
40308
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    61
\  --release <release>              Provide source compatibility with specified release\n\
18005
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    62
\  -extdirs <dirlist>               Override location of installed extensions\n\
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    63
\  -verbose                         Output messages about what Javadoc is doing\n\
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    64
\  -locale <name>                   Locale to be used, e.g. en_US or en_US_WIN\n\
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    65
\  -encoding <name>                 Source file encoding name\n\
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    66
\  -quiet                           Do not display status messages\n\
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    67
\  -J<flag>                         Pass <flag> directly to the runtime system\n\
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    68
\  -X                               Print a synopsis of nonstandard options and exit\n
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    69
40308
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    70
main.usage.foot=\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    71
GNU-style options may use '=' instead whitespace to separate the name of an option\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    72
from its value.\n
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    73
5850
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents: 5848
diff changeset
    74
main.Xusage=\
18005
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    75
\  -Xmaxerrs <number>               Set the maximum number of errors to print\n\
40308
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    76
\  -Xmaxwarns <number>              Set the maximum number of warnings to print\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    77
\  --add-exports <module>/<package>=<other-module>(,<other-module>)*\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    78
\                                   Specify a package to be considered as exported from its \n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    79
\                                   defining module to additional modules, or to all unnamed \n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    80
\                                   modules if <other-module> is ALL-UNNAMED.\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    81
\  --add-reads <module>=<other-module>(,<other-module>)*\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    82
\                                   Specify additional modules to be considered as required by a\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    83
\                                   given module. <other-module> may be ALL-UNNAMED to require\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    84
\                                   the unnamed module.\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    85
\  --patch-module <module>=<file>(:<file>)*\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    86
\                                   Override or augment a module with classes and resources\n\
274367a99f98 8136930: Simplify use of module-system options by custom launchers
jjg
parents: 36526
diff changeset
    87
\                                   in JAR files or directories\n
18005
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    88
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    89
main.Xusage.foot=\
5850
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents: 5848
diff changeset
    90
These options are non-standard and subject to change without notice.
18005
598e2e068668 8007687: javadoc -X does not include -Xdoclint
jjg
parents: 14545
diff changeset
    91
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
main.option.already.seen=The {0} option may be specified no more than once.
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
main.requires_argument=option {0} requires an argument.
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
main.locale_first=option -locale must be first on the command line.
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
main.invalid_flag=invalid flag: {0}
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
main.No_packages_or_classes_specified=No packages or classes specified.
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
main.incompatible.access.flags=More than one of -public, -private, -package, or -protected specified.
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
main.cant.read=cannot read {0}
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
main.Loading_source_files_for_package=Loading source files for package {0}...
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
main.Loading_source_file=Loading source file {0}...
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
main.Building_tree=Constructing Javadoc information...
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
main.no_source_files_for_package=No source files for package {0}
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
main.fatal.error=fatal error
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
main.fatal.exception=fatal exception
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
main.out.of.memory=java.lang.OutOfMemoryError: Please increase memory.\n\
5848
c5a4ce47e780 6960407: Potential rebranding issues in openjdk/langtools repository sources
jjg
parents: 5520
diff changeset
   106
For example, on the JDK Classic or HotSpot VMs, add the option -J-Xmx\n\
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
such as -J-Xmx32m.
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
main.done_in=[done in {0} ms]
06bc494ca11e Initial load
duke
parents:
diff changeset
   109
main.doclet_method_must_be_static=In doclet class {0}, method {1} must be static.
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
main.must_return_int=In doclet class {0}, method {1} must return int.
06bc494ca11e Initial load
duke
parents:
diff changeset
   111
main.must_return_boolean=In doclet class {0}, method {1} must return boolean.
06bc494ca11e Initial load
duke
parents:
diff changeset
   112
main.must_return_languageversion=In doclet class {0}, method {1} must return LanguageVersion.
06bc494ca11e Initial load
duke
parents:
diff changeset
   113
main.more_than_one_doclet_specified_0_and_1=More than one doclet specified ({0} and {1}).
06bc494ca11e Initial load
duke
parents:
diff changeset
   114
main.doclet_class_not_found=Cannot find doclet class {0}
06bc494ca11e Initial load
duke
parents:
diff changeset
   115
main.doclet_method_not_found=Doclet class {0} does not contain a {1} method
06bc494ca11e Initial load
duke
parents:
diff changeset
   116
main.doclet_method_not_accessible=In doclet class {0},  method {1} not accessible
06bc494ca11e Initial load
duke
parents:
diff changeset
   117
main.internal_error_exception_thrown=Internal error: In doclet class {0},  method {1} has thrown an exception {2}
06bc494ca11e Initial load
duke
parents:
diff changeset
   118
main.exception_thrown=In doclet class {0},  method {1} has thrown an exception {2}
06bc494ca11e Initial load
duke
parents:
diff changeset
   119
main.illegal_locale_name=Locale not available: {0}
06bc494ca11e Initial load
duke
parents:
diff changeset
   120
main.malformed_locale_name=Malformed locale name: {0}
06bc494ca11e Initial load
duke
parents:
diff changeset
   121
main.file_not_found=File not found: "{0}"
36526
3b41f1c69604 8142968: Module System implementation
alanb
parents: 32163
diff changeset
   122
main.file_ignored=File ignored: "{0}" (not yet supported)
32163
2bdcabf14e91 8133223: Clean up package handling code in JavadocTool
jjg
parents: 31936
diff changeset
   123
main.illegal_class_name=Illegal class name: "{0}"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   124
main.illegal_package_name=Illegal package name: "{0}"
31936
02f1cfc234a0 8086737: Add support for -release to Javadoc
jlahoda
parents: 25874
diff changeset
   125
main.release.bootclasspath.conflict=option {0} cannot be used together with -release
02f1cfc234a0 8086737: Add support for -release to Javadoc
jlahoda
parents: 25874
diff changeset
   126
main.unsupported.release.version=release version {0} not supported
42260
2b4da2bf6660 8169676: boolean result of Option.process is often ignored
jjg
parents: 40308
diff changeset
   127
main.option.invalid.value={0}
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   128
tag.illegal_char_in_arr_dim=Tag {0}: Syntax Error in array dimension, method parameters: {1}
06bc494ca11e Initial load
duke
parents:
diff changeset
   129
tag.illegal_see_tag=Tag {0}: Syntax Error in method parameters: {1}
06bc494ca11e Initial load
duke
parents:
diff changeset
   130
tag.missing_comma_space=Tag {0}: Missing comma or space in method parameters: {1}
06bc494ca11e Initial load
duke
parents:
diff changeset
   131
tag.tag_has_no_arguments={0} tag has no arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
   132
tag.see.missing_sharp=Tag {0}: missing ''#'': "{1}"
06bc494ca11e Initial load
duke
parents:
diff changeset
   133
tag.see.can_not_find_member=Tag {0}: can''t find {1} in {2}
06bc494ca11e Initial load
duke
parents:
diff changeset
   134
tag.see.no_close_bracket_on_url=Tag {0}: missing final ''>'': "{1}"
06bc494ca11e Initial load
duke
parents:
diff changeset
   135
tag.see.no_close_quote=Tag {0}: no final close quote: "{1}"
06bc494ca11e Initial load
duke
parents:
diff changeset
   136
tag.see.class_not_specified=Tag {0}: class not specified: "{1}"
06bc494ca11e Initial load
duke
parents:
diff changeset
   137
tag.see.illegal_character=Tag {0}:illegal character: "{1}" in "{2}"
06bc494ca11e Initial load
duke
parents:
diff changeset
   138
tag.see.malformed_see_tag=Tag {0}: malformed: "{1}"
06bc494ca11e Initial load
duke
parents:
diff changeset
   139
tag.End_delimiter_missing_for_possible_SeeTag=End Delimiter } missing for possible See Tag in comment string: "{0}"
06bc494ca11e Initial load
duke
parents:
diff changeset
   140
tag.Improper_Use_Of_Link_Tag=Missing closing ''}'' character for inline tag: "{0}"
14447
6f87132c2e54 8000612: Discrepancy between resources provided in javadoc resource files and resources required by code
jjg
parents: 8632
diff changeset
   141
tag.serialField.illegal_character=illegal character {0} in @serialField tag: {1}.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   142
javadoc.File_Read_Error=Error while reading file {0}
8632
af2a1f02c8ac 6227454: package.html and overview.html may not be read fully
jjg
parents: 7681
diff changeset
   143
javadoc.Body_missing_from_html_file=Body tag missing from HTML file
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   144
javadoc.End_body_missing_from_html_file=Close body tag missing from HTML file
06bc494ca11e Initial load
duke
parents:
diff changeset
   145
javadoc.Multiple_package_comments=Multiple sources of package comments found for package "{0}"
43261
d377e97291d8 8138725: Add options for Javadoc generation
jjg
parents: 42260
diff changeset
   146
javadoc.JavaScript_in_comment=JavaScript found in documentation comment.\n\
d377e97291d8 8138725: Add options for Javadoc generation
jjg
parents: 42260
diff changeset
   147
    Use --allow-script-in-comments to allow use of JavaScript.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   148
javadoc.class_not_found=Class {0} not found.
06bc494ca11e Initial load
duke
parents:
diff changeset
   149
javadoc.error=error
06bc494ca11e Initial load
duke
parents:
diff changeset
   150
javadoc.warning=warning
14545
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents: 14447
diff changeset
   151
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents: 14447
diff changeset
   152
javadoc.error.msg={0}: error - {1}
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents: 14447
diff changeset
   153
javadoc.warning.msg={0}: warning - {1}
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents: 14447
diff changeset
   154
javadoc.note.msg = {1}
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents: 14447
diff changeset
   155
javadoc.note.pos.msg= {0}: {1}