doclint.properties revision 2846:072008f47620
1#
2# Copyright (c) 2012, 2015, 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.obsolete = attribute obsolete: {0}
31dc.attr.obsolete.use.css = attribute obsolete, use CSS instead: {0}
32dc.attr.repeated = repeated attribute: {0}
33dc.attr.unknown = unknown attribute: {0}
34dc.bad.option = bad option: {0}
35dc.bad.value.for.option = bad value for option: {0} {1}
36dc.empty = no description for @{0}
37dc.entity.invalid = invalid entity &{0};
38dc.exception.not.thrown = exception not thrown: {0}
39dc.invalid.anchor = invalid name for anchor: "{0}"
40dc.invalid.param = invalid use of @param
41dc.invalid.return = invalid use of @return
42dc.invalid.throws = invalid use of @throws
43dc.invalid.uri = invalid uri: "{0}"
44dc.missing.comment = no comment
45dc.missing.param = no @param for {0}
46dc.missing.return = no @return
47dc.missing.throws = no @throws for {0}
48dc.no.alt.attr.for.image = no "alt" attribute for image
49dc.no.summary.or.caption.for.table=no summary or caption for table
50dc.param.name.not.found = @param name not found
51dc.ref.not.found = reference not found
52dc.tag.code.within.code = '{@code'} within <code>
53dc.tag.empty = empty <{0}> tag
54dc.tag.end.not.permitted = invalid end tag: </{0}>
55dc.tag.end.unexpected = unexpected end tag: </{0}>
56dc.tag.header.sequence.1 = header used out of sequence: <{0}>
57dc.tag.header.sequence.2 = header used out of sequence: <{0}>
58dc.tag.nested.not.allowed=nested tag not allowed: <{0}>
59dc.tag.not.allowed.here = tag not allowed here: <{0}>
60dc.tag.not.allowed = element not allowed in documentation comments: <{0}>
61dc.tag.not.allowed.inline.element = block element not allowed within inline element <{1}>: {0}
62dc.tag.not.allowed.inline.tag = block element not allowed within @{1}: {0}
63dc.tag.not.allowed.inline.other = block element not allowed here: {0}
64dc.tag.not.closed= element not closed: {0}
65dc.tag.p.in.pre= unexpected use of <p> inside <pre> element
66dc.tag.self.closing = self-closing element not allowed
67dc.tag.start.unmatched = end tag missing: </{0}>
68dc.tag.unknown = unknown tag: {0}
69dc.text.not.allowed = text not allowed in <{0}> element
70dc.type.arg.not.allowed = type arguments not allowed here
71dc.unexpected.comment=documentation comment not expected here
72dc.value.not.allowed.here='{@value}' not allowed here
73dc.value.not.a.constant=value does not refer to a constant
74
75dc.main.ioerror=IO error: {0}
76dc.main.no.files.given=No files given
77dc.main.usage=\
78Usage:\n\
79\    doclint [options] source-files...\n\
80\n\
81Options:\n\
82\  -Xmsgs  \n\
83\    Same as -Xmsgs:all\n\
84\  -Xmsgs:values\n\
85\    Specify categories of issues to be checked, where ''values''\n\
86\    is a comma-separated list of any of the following:\n\
87\      reference      show places where comments contain incorrect\n\
88\                     references to Java source code elements\n\
89\      syntax         show basic syntax errors within comments\n\
90\      html           show issues with HTML tags and attributes\n\
91\      accessibility  show issues for accessibility\n\
92\      missing        show issues with missing documentation\n\
93\      all            all of the above\n\
94\    Precede a value with ''-'' to negate it\n\
95\    Categories may be qualified by one of:\n\
96\      /public /protected /package /private\n\
97\    For positive categories (not beginning with ''-'')\n\
98\    the qualifier applies to that access level and above.\n\
99\    For negative categories (beginning with ''-'')\n\
100\    the qualifier applies to that access level and below.\n\
101\    If a qualifier is missing, the category applies to\n\
102\    all access levels.\n\
103\    For example, -Xmsgs:all,-syntax/private\n\
104\    This will enable all messages, except syntax errors\n\
105\    in the doc comments of private methods.\n\
106\    If no -Xmsgs options are provided, the default is\n\
107\    equivalent to -Xmsgs:all/protected, meaning that\n\
108\    all messages are reported for protected and public\n\
109\    declarations only. \n\
110\  -XcheckPackage:<packages>\n\
111\    Enable or disable checks in specific packages.\n\
112\    <packages> is a comma separated list of package specifiers.\n\
113\    Package specifier is either a qualified name of a package\n\
114\    or a package name prefix followed by ''.*'', which expands to\n\
115\    all sub-packages of the given package. Prefix the package specifier\n\
116\    with ''-'' to disable checks for the specified packages.\n\
117\  -stats\n\
118\    Report statistics on the reported issues.\n\
119\  -h -help --help -usage -?\n\
120\    Show this message.\n\
121\n\
122The following javac options are also supported\n\
123\  -bootclasspath, -classpath, -cp, -sourcepath, -Xmaxerrs, -Xmaxwarns\n\
124\n\
125To run doclint on part of a project, put the compiled classes for your\n\
126project on the classpath (or bootclasspath), then specify the source files\n\
127to be checked on the command line.
128