author | jjg |
Tue, 24 Sep 2013 11:46:25 -0700 | |
changeset 20255 | f8be1ea20e1a |
parent 19121 | c626ed0c6ab0 |
child 20256 | 9154c5cc0d9f |
permissions | -rw-r--r-- |
14952 | 1 |
# |
15359 | 2 |
# Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved. |
14952 | 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 |
||
26 |
dc.anchor.already.defined = anchor already defined: {0} |
|
15359 | 27 |
dc.anchor.value.missing = no value given for anchor |
14952 | 28 |
dc.attr.lacks.value = attribute lacks value |
18001 | 29 |
dc.attr.not.number = attribute value is not a number |
14952 | 30 |
dc.attr.obsolete = attribute obsolete: {0} |
31 |
dc.attr.obsolete.use.css = attribute obsolete, use CSS instead: {0} |
|
32 |
dc.attr.repeated = repeated attribute: {0} |
|
33 |
dc.attr.unknown = unknown attribute: {0} |
|
34 |
dc.bad.option = bad option: {0} |
|
35 |
dc.bad.value.for.option = bad value for option: {0} {1} |
|
36 |
dc.empty = no description for @{0} |
|
37 |
dc.entity.invalid = invalid entity &{0}; |
|
38 |
dc.exception.not.thrown = exception not thrown: {0} |
|
39 |
dc.invalid.anchor = invalid name for anchor: "{0}" |
|
40 |
dc.invalid.param = invalid use of @param |
|
41 |
dc.invalid.return = invalid use of @return |
|
42 |
dc.invalid.throws = invalid use of @throws |
|
43 |
dc.invalid.uri = invalid uri: "{0}" |
|
44 |
dc.missing.comment = no comment |
|
45 |
dc.missing.param = no @param for {0} |
|
46 |
dc.missing.return = no @return |
|
47 |
dc.missing.throws = no @throws for {0} |
|
48 |
dc.no.alt.attr.for.image = no "alt" attribute for image |
|
49 |
dc.no.summary.or.caption.for.table=no summary or caption for table |
|
50 |
dc.param.name.not.found = @param name not found |
|
51 |
dc.ref.not.found = reference not found |
|
15366
545307ec740c
8006228: Doclint doesn't detect <code> {@code nested inline} </code>
jjg
parents:
15359
diff
changeset
|
52 |
dc.tag.code.within.code = '{@code'} within <code> |
14952 | 53 |
dc.tag.empty = empty <{0}> tag |
54 |
dc.tag.end.not.permitted = invalid end tag: </{0}> |
|
55 |
dc.tag.end.unexpected = unexpected end tag: </{0}> |
|
56 |
dc.tag.header.sequence.1 = header used out of sequence: <{0}> |
|
57 |
dc.tag.header.sequence.2 = header used out of sequence: <{0}> |
|
58 |
dc.tag.nested.not.allowed=nested tag not allowed: <{0}> |
|
15371
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15366
diff
changeset
|
59 |
dc.tag.not.allowed.here = tag not allowed here: <{0}> |
14952 | 60 |
dc.tag.not.allowed = element not allowed in documentation comments: <{0}> |
61 |
dc.tag.not.allowed.inline.element = block element not allowed within inline element <{1}>: {0} |
|
62 |
dc.tag.not.allowed.inline.tag = block element not allowed within @{1}: {0} |
|
63 |
dc.tag.not.allowed.inline.other = block element not allowed here: {0} |
|
64 |
dc.tag.not.closed= element not closed: {0} |
|
65 |
dc.tag.p.in.pre= unexpected use of <p> inside <pre> element |
|
66 |
dc.tag.self.closing = self-closing element not allowed |
|
67 |
dc.tag.start.unmatched = end tag missing: </{0}> |
|
68 |
dc.tag.unknown = unknown tag: {0} |
|
69 |
dc.text.not.allowed = text not allowed in <{0}> element |
|
19121
c626ed0c6ab0
8020664: doclint gives incorrect warnings on normal package statements
jjg
parents:
18898
diff
changeset
|
70 |
dc.unexpected.comment=documentation comment not expected here |
20255
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
19121
diff
changeset
|
71 |
dc.value.not.allowed.here='{@value}' not allowed here |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
19121
diff
changeset
|
72 |
dc.value.not.a.constant=value does not refer to a constant |
18004
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
73 |
|
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
74 |
dc.main.ioerror=IO error: {0} |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
75 |
dc.main.no.files.given=No files given |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
76 |
dc.main.usage=\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
77 |
Usage:\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
78 |
\ doclint [options] source-files...\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
79 |
\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
80 |
Options:\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
81 |
\ -Xmsgs \n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
82 |
\ Same as -Xmsgs:all\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
83 |
\ -Xmsgs:values\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
84 |
\ Specify categories of issues to be checked, where ''values''\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
85 |
\ is a comma-separated list of any of the following:\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
86 |
\ reference show places where comments contain incorrect\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
87 |
\ references to Java source code elements\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
88 |
\ syntax show basic syntax errors within comments\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
89 |
\ html show issues with HTML tags and attributes\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
90 |
\ accessibility show issues for accessibility\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
91 |
\ missing show issues with missing documentation\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
92 |
\ all all of the above\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
93 |
\ Precede a value with ''-'' to negate it\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
94 |
\ Categories may be qualified by one of:\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
95 |
\ /public /protected /package /private\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
96 |
\ For positive categories (not beginning with ''-'')\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
97 |
\ the qualifier applies to that access level and above.\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
98 |
\ For negative categories (beginning with ''-'')\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
99 |
\ the qualifier applies to that access level and below.\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
100 |
\ If a qualifier is missing, the category applies to\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
101 |
\ all access levels.\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
102 |
\ For example, -Xmsgs:all,-syntax/private\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
103 |
\ This will enable all messages, except syntax errors\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
104 |
\ in the doc comments of private methods.\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
105 |
\ If no -Xmsgs options are provided, the default is\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
106 |
\ equivalent to -Xmsgs:all/protected, meaning that\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
107 |
\ all messages are reported for protected and public\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
108 |
\ declarations only. \n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
109 |
\ -stats\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
110 |
\ Report statistics on the reported issues.\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
111 |
\ -h -help --help -usage -?\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
112 |
\ Show this message.\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
113 |
\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
114 |
The following javac options are also supported\n\ |
18898
0eab5f5e3d1d
8009924: some langtools tools do not accept -cp as an alias for -classpath
vromero
parents:
18004
diff
changeset
|
115 |
\ -bootclasspath, -classpath, -cp, -sourcepath, -Xmaxerrs, -Xmaxwarns\n\ |
18004
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
116 |
\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
117 |
To run doclint on part of a project, put the compiled classes for your\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
118 |
project on the classpath (or bootclasspath), then specify the source files\n\ |
dcf9d59b1635
8006615: [doclint] move remaining messages into resource bundle
jjg
parents:
18001
diff
changeset
|
119 |
to be checked on the command line. |