doclint.properties revision 3928:37c0e34e835c
1#
2# Copyright (c) 2012, 2017, Oracle and/or its affiliates. All rights reserved.
3# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4#
5# This code is free software; you can redistribute it and/or modify it
6# under the terms of the GNU General Public License version 2 only, as
7# published by the Free Software Foundation.  Oracle designates this
8# particular file as subject to the "Classpath" exception as provided
9# by Oracle in the LICENSE file that accompanied this code.
10#
11# This code is distributed in the hope that it will be useful, but WITHOUT
12# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14# version 2 for more details (a copy is included in the LICENSE file that
15# accompanied this code).
16#
17# You should have received a copy of the GNU General Public License version
18# 2 along with this work; if not, write to the Free Software Foundation,
19# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20#
21# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22# or visit www.oracle.com if you need additional information or have any
23# questions.
24#
25
26dc.anchor.already.defined = anchor already defined: "{0}"
27dc.anchor.value.missing = no value given for anchor
28dc.attr.lacks.value = attribute lacks value
29dc.attr.not.number = attribute value is not a number
30dc.attr.not.supported.html4 = attribute not supported in HTML4: {0}
31dc.attr.not.supported.html5 = attribute not supported in HTML5: {0}
32dc.attr.obsolete = attribute obsolete: {0}
33dc.attr.obsolete.use.css = attribute obsolete, use CSS instead: {0}
34dc.attr.repeated = repeated attribute: {0}
35dc.attr.table.border.html5 = attribute border for table only accepts "" or "1", use CSS instead: {0}
36dc.attr.unknown = unknown attribute: {0}
37dc.bad.option = bad option: {0}
38dc.bad.value.for.option = bad value for option: {0} {1}
39dc.empty = no description for @{0}
40dc.entity.invalid = invalid entity &{0};
41dc.exception.not.thrown = exception not thrown: {0}
42dc.exists.param = @param "{0}" has already been specified
43dc.exists.return = @return has already been specified
44dc.invalid.anchor = invalid name for anchor: "{0}"
45dc.invalid.param = invalid use of @param
46dc.invalid.provides = invalid use of @provides
47dc.invalid.return = invalid use of @return
48dc.invalid.throws = invalid use of @throws
49dc.invalid.uses = invalid use of @uses
50dc.invalid.uri = invalid uri: "{0}"
51dc.missing.comment = no comment
52dc.missing.param = no @param for {0}
53dc.missing.return = no @return
54dc.missing.throws = no @throws for {0}
55dc.no.alt.attr.for.image = no "alt" attribute for image
56dc.no.summary.or.caption.for.table=no summary or caption for table
57dc.param.name.not.found = @param name not found
58dc.ref.not.found = reference not found
59dc.service.not.found = service-type not found
60dc.tag.code.within.code = '{@code'} within <code>
61dc.tag.empty = empty <{0}> tag
62dc.tag.end.not.permitted = invalid end tag: </{0}>
63dc.tag.end.unexpected = unexpected end tag: </{0}>
64dc.tag.header.sequence.1 = header used out of sequence: <{0}>
65dc.tag.header.sequence.2 = header used out of sequence: <{0}>
66dc.tag.nested.not.allowed=nested tag not allowed: <{0}>
67dc.tag.not.allowed.here = tag not allowed here: <{0}>
68dc.tag.not.allowed = element not allowed in documentation comments: <{0}>
69dc.tag.not.allowed.inline.element = block element not allowed within inline element <{1}>: {0}
70dc.tag.not.allowed.inline.tag = block element not allowed within @{1}: {0}
71dc.tag.not.allowed.inline.other = block element not allowed here: {0}
72dc.tag.not.closed= element not closed: {0}
73dc.tag.p.in.pre= unexpected use of <p> inside <pre> element
74dc.tag.requires.heading = heading not found for </{0}>
75dc.tag.self.closing = self-closing element not allowed
76dc.tag.start.unmatched = end tag missing: </{0}>
77dc.tag.unknown = unknown tag: {0}
78dc.tag.not.supported = tag not supported in the generated HTML version: {0}
79dc.text.not.allowed = text not allowed in <{0}> element
80dc.type.arg.not.allowed = type arguments not allowed here
81dc.unexpected.comment=documentation comment not expected here
82dc.value.not.allowed.here='{@value}' not allowed here
83dc.value.not.a.constant=value does not refer to a constant
84
85dc.main.ioerror=IO error: {0}
86dc.main.no.files.given=No files given
87dc.main.usage=\
88Usage:\n\
89\    doclint [options] source-files...\n\
90\n\
91Options:\n\
92\  -Xmsgs  \n\
93\    Same as -Xmsgs:all\n\
94\  -Xmsgs:values\n\
95\    Specify categories of issues to be checked, where ''values''\n\
96\    is a comma-separated list of any of the following:\n\
97\      reference      show places where comments contain incorrect\n\
98\                     references to Java source code elements\n\
99\      syntax         show basic syntax errors within comments\n\
100\      html           show issues with HTML tags and attributes\n\
101\      accessibility  show issues for accessibility\n\
102\      missing        show issues with missing documentation\n\
103\      all            all of the above\n\
104\    Precede a value with ''-'' to negate it\n\
105\    Categories may be qualified by one of:\n\
106\      /public /protected /package /private\n\
107\    For positive categories (not beginning with ''-'')\n\
108\    the qualifier applies to that access level and above.\n\
109\    For negative categories (beginning with ''-'')\n\
110\    the qualifier applies to that access level and below.\n\
111\    If a qualifier is missing, the category applies to\n\
112\    all access levels.\n\
113\    For example, -Xmsgs:all,-syntax/private\n\
114\    This will enable all messages, except syntax errors\n\
115\    in the doc comments of private methods.\n\
116\    If no -Xmsgs options are provided, the default is\n\
117\    equivalent to -Xmsgs:all/protected, meaning that\n\
118\    all messages are reported for protected and public\n\
119\    declarations only. \n\
120\  -XcheckPackage:<packages>\n\
121\    Enable or disable checks in specific packages.\n\
122\    <packages> is a comma separated list of package specifiers.\n\
123\    Package specifier is either a qualified name of a package\n\
124\    or a package name prefix followed by ''.*'', which expands to\n\
125\    all sub-packages of the given package. Prefix the package specifier\n\
126\    with ''-'' to disable checks for the specified packages.\n\
127\  -stats\n\
128\    Report statistics on the reported issues.\n\
129\  -h -help --help -usage -?\n\
130\    Show this message.\n\
131\n\
132The following javac options are also supported\n\
133\  -bootclasspath, -classpath, -cp, -sourcepath, -Xmaxerrs, -Xmaxwarns\n\
134\n\
135To run doclint on part of a project, put the compiled classes for your\n\
136project on the classpath (or bootclasspath), then specify the source files\n\
137to be checked on the command line.
138