forked from openjdk/jdk
/
doclint.properties
145 lines (143 loc) · 7.11 KB
/
doclint.properties
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
#
# Copyright (c) 2012, 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.
#
dc.anchor.already.defined = anchor already defined: "{0}"
dc.anchor.value.missing = no value given for anchor
dc.attr.lacks.value = attribute lacks value
dc.attr.not.number = attribute value is not a number
dc.attr.not.supported.html5 = attribute not supported in HTML5: {0}
dc.attr.obsolete = attribute obsolete: {0}
dc.attr.repeated = repeated attribute: {0}
dc.attr.img.border.not.valid = attribute "border" for img only accepts "0": {0}
dc.attr.img.border.not.number = invalid value for attribute "border": {0}
dc.attr.table.border.not.valid = attribute "border" for table only accepts "" or "1": {0}
dc.attr.table.border.not.number = invalid value for attribute "border": {0}
dc.attr.unknown = unknown attribute: {0}
dc.bad.option = bad option: {0}
dc.bad.value.for.option = bad value for option: {0} {1}
dc.default.constructor = use of default constructor, which does not provide a comment
dc.empty = no description for @{0}
dc.empty.comment = empty comment
dc.empty.description = no initial description
dc.entity.invalid = invalid entity &{0};
dc.exception.not.thrown = exception not thrown: {0}
dc.exists.param = @param "{0}" has already been specified
dc.exists.return = @return has already been specified
dc.invalid.anchor = invalid name for anchor: "{0}"
dc.invalid.param = invalid use of @param
dc.invalid.provides = invalid use of @provides
dc.invalid.return = invalid use of @return
dc.invalid.summary = invalid use of @summary
dc.invalid.throws = invalid use of @throws
dc.invalid.uses = invalid use of @uses
dc.invalid.uri = invalid uri: "{0}"
dc.missing.comment = no comment
dc.missing.param = no @param for {0}
dc.missing.return = no @return
dc.missing.throws = no @throws for {0}
dc.no.alt.attr.for.image = no "alt" attribute for image
dc.no.summary.or.caption.for.table=no caption for table
dc.param.name.not.found = @param name not found
dc.ref.not.found = reference not found
dc.return.not.first = '{@return} not at beginning of description
dc.service.not.found = service-type not found
dc.tag.code.within.code = '{@code} within <code>
dc.tag.empty = empty <{0}> tag
dc.tag.a.within.a = {0} tag, which expands to <a>, within <a>
dc.tag.end.not.permitted = invalid end tag: </{0}>
dc.tag.end.unexpected = unexpected end tag: </{0}>
dc.tag.heading.sequence.1 = heading used out of sequence: <{0}>, compared to implicit preceding heading: <H{1}>
dc.tag.heading.sequence.2 = heading used out of sequence: <{0}>, compared to previous heading: <{1}>
dc.tag.heading.sequence.3 = unexpected heading used: <{0}>, compared to implicit preceding heading: <H{1}>
dc.tag.nested.not.allowed=nested tag not allowed: <{0}>
dc.tag.nested.tag=nested tag: {0}
dc.tag.not.allowed.here = tag not allowed here: <{0}>
dc.tag.not.allowed = element not allowed in documentation comments: <{0}>
dc.tag.not.allowed.inline.element = block element not allowed within inline element <{1}>: {0}
dc.tag.not.allowed.inline.tag = block element not allowed within @{1}: {0}
dc.tag.not.allowed.inline.other = block element not allowed here: {0}
dc.tag.not.closed= element not closed: {0}
dc.tag.p.in.pre= unexpected use of <p> inside <pre> element
dc.tag.requires.heading = heading not found for </{0}>
dc.tag.self.closing = self-closing element not allowed
dc.tag.start.unmatched = end tag missing: </{0}>
dc.tag.unknown = unknown tag: {0}
dc.tag.not.supported.html5 = tag not supported in HTML5: {0}
dc.text.not.allowed = text not allowed in <{0}> element
dc.unexpected.comment=documentation comment not expected here
dc.value.not.allowed.here='{@value} not allowed here
dc.value.not.a.constant=value does not refer to a constant
dc.main.ioerror=IO error: {0}
dc.main.no.files.given=No files given
dc.main.usage=\
Usage:\n\
\ doclint [options] source-files...\n\
\n\
Options:\n\
\ -Xmsgs \n\
\ Same as -Xmsgs:all\n\
\ -Xmsgs:values\n\
\ Specify categories of issues to be checked, where ''values''\n\
\ is a comma-separated list of any of the following:\n\
\ reference show places where comments contain incorrect\n\
\ references to Java source code elements\n\
\ syntax show basic syntax errors within comments\n\
\ html show issues with HTML tags and attributes\n\
\ accessibility show issues for accessibility\n\
\ missing show issues with missing documentation\n\
\ all all of the above\n\
\ Precede a value with ''-'' to negate it\n\
\ Categories may be qualified by one of:\n\
\ /public /protected /package /private\n\
\ For positive categories (not beginning with ''-'')\n\
\ the qualifier applies to that access level and above.\n\
\ For negative categories (beginning with ''-'')\n\
\ the qualifier applies to that access level and below.\n\
\ If a qualifier is missing, the category applies to\n\
\ all access levels.\n\
\ For example, -Xmsgs:all,-syntax/private\n\
\ This will enable all messages, except syntax errors\n\
\ in the doc comments of private methods.\n\
\ If no -Xmsgs options are provided, the default is\n\
\ equivalent to -Xmsgs:all/protected, meaning that\n\
\ all messages are reported for protected and public\n\
\ declarations only. \n\
\ -XcheckPackage:<packages>\n\
\ Enable or disable checks in specific packages.\n\
\ <packages> is a comma separated list of package specifiers.\n\
\ Package specifier is either a qualified name of a package\n\
\ or a package name prefix followed by ''.*'', which expands to\n\
\ all sub-packages of the given package. Prefix the package specifier\n\
\ with ''-'' to disable checks for the specified packages.\n\
\ -stats\n\
\ Report statistics on the reported issues.\n\
\ -h -help --help -usage -?\n\
\ Show this message.\n\
\n\
The following javac options are also supported\n\
\ -bootclasspath, -classpath, -cp, -sourcepath, -Xmaxerrs, -Xmaxwarns\n\
\n\
To run doclint on part of a project, put the compiled classes for your\n\
project on the classpath (or bootclasspath), then specify the source files\n\
to be checked on the command line.