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