archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-09-21 11:34:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

7177970: fix issues in langtools doc comments

Browse source 
Reviewed-by: mcimadamore
This commit is contained in:
Jonathan Gibbons 2012-09-13 14:29:36 -07:00
parent 2c45db0933
commit ae09b79839
34 changed files with 134 additions and 101 deletions
Download patch file Download diff file Expand all files Collapse all files

6
langtools/src/share/classes/com/sun/javadoc/Doc.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2012, 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
@ -76,7 +76,7 @@ public interface Doc extends Comparable<Object> {
/**
* Return comment as an array of tags. Includes inline tags
* (i.e. {&#64link <i>reference</i>} tags) but not
* (i.e. {&#64;link <i>reference</i>} tags) but not
* block tags.
* Each section of plain text is represented as a {@link Tag}
* of {@linkplain Tag#kind() kind} "Text".
@ -90,7 +90,7 @@ public interface Doc extends Comparable<Object> {
/**
* Return the first sentence of the comment as an array of tags.
* Includes inline tags
* (i.e. {&#64link <i>reference</i>} tags) but not
* (i.e. {&#64;link <i>reference</i>} tags) but not
* block tags.
* Each section of plain text is represented as a {@link Tag}
* of {@linkplain Tag#kind() kind} "Text".

10
langtools/src/share/classes/com/sun/javadoc/ExecutableMemberDoc.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2012, 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
@ -90,8 +90,8 @@ public interface ExecutableMemberDoc extends MemberDoc {
/**
* Return the throws tags in this method.
*
* @return an array of ThrowTag containing all <code>&#64exception</code>
* and <code>&#64throws</code> tags.
* @return an array of ThrowTag containing all <code>&#64;exception</code>
* and <code>&#64;throws</code> tags.
*/
ThrowsTag[] throwsTags();
@ -99,7 +99,7 @@ public interface ExecutableMemberDoc extends MemberDoc {
* Return the param tags in this method, excluding the type
* parameter tags.
*
* @return an array of ParamTag containing all <code>&#64param</code> tags
* @return an array of ParamTag containing all <code>&#64;param</code> tags
* corresponding to the parameters of this method.
*/
ParamTag[] paramTags();
@ -107,7 +107,7 @@ public interface ExecutableMemberDoc extends MemberDoc {
/**
* Return the type parameter tags in this method.
*
* @return an array of ParamTag containing all <code>&#64param</code> tags
* @return an array of ParamTag containing all <code>&#64;param</code> tags
* corresponding to the type parameters of this method.
* @since 1.5
*/

4
langtools/src/share/classes/com/sun/javadoc/Tag.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2012, 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
@ -127,7 +127,7 @@ public interface Tag {
/**
* Return the first sentence of the comment as an array of tags.
* Includes inline tags
* (i.e. {&#64link <i>reference</i>} tags) but not
* (i.e. {&#64;link <i>reference</i>} tags) but not
* block tags.
* Each section of plain text is represented as a {@link Tag}
* of kind "Text".

6
langtools/src/share/classes/com/sun/source/tree/LambdaExpressionTree.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2011, 2012, 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
@ -31,11 +31,11 @@ import java.util.List;
* A tree node for a lambda expression.
*
* For example:
* <pre>
* <pre>{@code
* ()->{}
* (List<String> ls)->ls.size()
* (x,y)-> { return x + y; }
* </pre>
* }</pre>
*/
public interface LambdaExpressionTree extends ExpressionTree {

6
langtools/src/share/classes/com/sun/source/tree/LineMap.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2006, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2006, 2012, 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
@ -38,8 +38,8 @@ public interface LineMap {
* @param line line number (beginning at 1)
* @return position of first character in line
* @throws IndexOutOfBoundsException
* if <tt>lineNumber < 1</tt>
* if <tt>lineNumber > no. of lines</tt>
* if {@code lineNumber < 1}
* if {@code lineNumber > no. of lines}
*/
long getStartPosition(long line);

4
langtools/src/share/classes/com/sun/source/util/TreeScanner.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2005, 2012, 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
@ -52,7 +52,7 @@ import com.sun.source.tree.*;
*
* <p>Here is an example to count the number of identifier nodes in a tree:
* <pre>
* class CountIdentifiers extends TreeScanner<Integer,Void> {
* class CountIdentifiers extends TreeScanner&lt;Integer,Void&gt; {
* {@literal @}Override
* public Integer visitIdentifier(IdentifierTree node, Void p) {
* return 1;

12
langtools/src/share/classes/com/sun/tools/doclets/formats/html/HtmlDocletWriter.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2012, 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
@ -1260,7 +1260,7 @@ public class HtmlDocletWriter extends HtmlDocWriter {
/**
* Print the Html table tag for the index summary tables. The table tag
* printed is
* &lt;TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
* {@code <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> }
*/
public void tableIndexSummary() {
table(1, "100%", 3, 0);
@ -1548,7 +1548,7 @@ public class HtmlDocletWriter extends HtmlDocWriter {
}
/**
* Print the heading in Html &lt;H2> format.
* Print the heading in Html {@literal <H2>} format.
*
* @param str The Header string.
*/
@ -2416,15 +2416,15 @@ public class HtmlDocletWriter extends HtmlDocWriter {
* <p>
* Here is the algorithm used to fix the link:
* <p>
* &lt;relative link&gt; => docRoot + &lt;relative path to file&gt; + &lt;relative link&gt;
* {@literal <relative link> => docRoot + <relative path to file> + <relative link> }
* <p>
* For example, suppose com.sun.javadoc.RootDoc has this link:
* &lt;a href="package-summary.html"&gt;The package Page&lt;/a&gt;
* {@literal <a href="package-summary.html">The package Page</a> }
* <p>
* If this link appeared in the index, we would redirect
* the link like this:
*
* &lt;a href="./com/sun/javadoc/package-summary.html"&gt;The package Page&lt;/a&gt;
* {@literal <a href="./com/sun/javadoc/package-summary.html">The package Page</a>}
*
* @param doc the Doc object whose documentation is being written.
* @param text the text being written.

4
langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/ClassBuilder.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2012, 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
@ -125,7 +125,7 @@ public class ClassBuilder extends AbstractBuilder {
}
/**
* Handles the &lt;ClassDoc> tag.
* Handles the {@literal <ClassDoc>} tag.
*
* @param node the XML element that specifies which components to document
* @param contentTree the content tree to which the documentation will be added

3
langtools/src/share/classes/com/sun/tools/javac/code/Symtab.java
View file

@ -251,7 +251,8 @@ public class Symtab {
}
/** Enter a binary operation, as above but with two opcodes,
* which get encoded as (opcode1 << ByteCodeTags.preShift) + opcode2.
* which get encoded as
* {@code (opcode1 << ByteCodeTags.preShift) + opcode2 }.
* @param opcode1 First opcode.
* @param opcode2 Second opcode.
*/

2
langtools/src/share/classes/com/sun/tools/javac/code/Type.java
View file

@ -692,7 +692,7 @@ public class Type implements PrimitiveType {
/** A class type is raw if it misses some
* of its type parameter sections.
* After validation, this is equivalent to:
* allparams.isEmpty() && tsym.type.allparams.nonEmpty();
* {@code allparams.isEmpty() && tsym.type.allparams.nonEmpty(); }
*/
public boolean isRaw() {
return

5
langtools/src/share/classes/com/sun/tools/javac/comp/Check.java
View file

@ -2373,9 +2373,12 @@ public class Check {
tree.accept(new AnnotationValidator());
}
/** Annotation types are restricted to primitives, String, an
/**
* {@literal
* Annotation types are restricted to primitives, String, an
* enum, an annotation, Class, Class<?>, Class<? extends
* Anything>, arrays of the preceding.
* }
*/
void validateAnnotationType(JCTree restype) {
// restype may be null if an error occurred, so don't bother validating it

4
langtools/src/share/classes/com/sun/tools/javac/comp/Enter.java
View file

@ -77,12 +77,12 @@ import static com.sun.tools.javac.code.Kinds.*;
*
* <p>Classes migrate from one phase to the next via queues:
*
* <pre>
* <pre>{@literal
* class enter -> (Enter.uncompleted) --> member enter (1)
* -> (MemberEnter.halfcompleted) --> member enter (2)
* -> (Todo) --> attribute
* (only for toplevel classes)
* </pre>
* }</pre>
*
* <p><b>This is NOT part of any supported API.
* If you write code that depends on this, you do so at your own risk.

20
langtools/src/share/classes/com/sun/tools/javac/comp/Lower.java
View file

@ -1449,7 +1449,7 @@ public class Lower extends TreeTranslator {
return access(v, make.at(pos).Ident(v), null, false);
}
/** Construct a tree simulating the expression <C.this>.
/** Construct a tree simulating the expression {@code C.this}.
* @param pos The source code position to be used for the tree.
* @param c The qualifier class.
*/
@ -1623,7 +1623,7 @@ public class Lower extends TreeTranslator {
}
/** Construct a tree that represents the outer instance
* <C.this>. Never pick the current `this'.
* {@code C.this}. Never pick the current `this'.
* @param pos The source code position to be used for the tree.
* @param c The qualifier class.
*/
@ -1661,7 +1661,7 @@ public class Lower extends TreeTranslator {
}
/** Construct a tree that represents the closest outer instance
* <C.this> such that the given symbol is a member of C.
* {@code C.this} such that the given symbol is a member of C.
* @param pos The source code position to be used for the tree.
* @param sym The accessed symbol.
* @param preciseMatch should we accept a type that is a subtype of
@ -1713,7 +1713,7 @@ public class Lower extends TreeTranslator {
return tree;
}
/** Return tree simulating the assignment <this.name = name>, where
/** Return tree simulating the assignment {@code this.name = name}, where
* name is the name of a free variable.
*/
JCStatement initField(int pos, Name name) {
@ -1730,7 +1730,7 @@ public class Lower extends TreeTranslator {
make.Ident(rhs)).setType(lhs.erasure(types)));
}
/** Return tree simulating the assignment <this.this$n = this$n>.
/** Return tree simulating the assignment {@code this.this$n = this$n}.
*/
JCStatement initOuterThis(int pos) {
VarSymbol rhs = outerThisStack.head;
@ -3194,7 +3194,7 @@ public class Lower extends TreeTranslator {
*
* (where arrayexpr is of an array type) gets translated to
*
* <pre>
* <pre>{@code
* for ( { arraytype #arr = arrayexpr;
* int #len = array.length;
* int #i = 0; };
@ -3202,7 +3202,7 @@ public class Lower extends TreeTranslator {
* T v = arr$[#i];
* stmt;
* }
* </pre>
* }</pre>
*
* where #arr, #len, and #i are freshly named synthetic local variables.
*/
@ -3272,14 +3272,14 @@ public class Lower extends TreeTranslator {
* for ( T v : coll ) stmt ;
* </pre>
*
* (where coll implements Iterable<? extends T>) gets translated to
* (where coll implements {@code Iterable<? extends T>}) gets translated to
*
* <pre>
* <pre>{@code
* for ( Iterator<? extends T> #i = coll.iterator(); #i.hasNext(); ) {
* T v = (T) #i.next();
* stmt;
* }
* </pre>
* }</pre>
*
* where #i is a freshly named synthetic local variable.
*/

8
langtools/src/share/classes/com/sun/tools/javac/comp/Resolve.java
View file

@ -1516,7 +1516,7 @@ public class Resolve {
/** If `sym' is a bad symbol: report error and return errSymbol
* else pass through unchanged,
* additional arguments duplicate what has been used in trying to find the
* symbol (--> flyweight pattern). This improves performance since we
* symbol {@literal (--> flyweight pattern)}. This improves performance since we
* expect misses to happen frequently.
*
* @param sym The symbol that was found, or a ResolveError.
@ -1903,9 +1903,9 @@ public class Resolve {
/** This method scans all the constructor symbol in a given class scope -
* assuming that the original scope contains a constructor of the kind:
* Foo(X x, Y y), where X,Y are class type-variables declared in Foo,
* {@code Foo(X x, Y y)}, where X,Y are class type-variables declared in Foo,
* a method check is executed against the modified constructor type:
* <X,Y>Foo<X,Y>(X x, Y y). This is crucial in order to enable diamond
* {@code <X,Y>Foo<X,Y>(X x, Y y)}. This is crucial in order to enable diamond
* inference. The inferred return type of the synthetic constructor IS
* the inferred type for the diamond operator.
*/
@ -2223,7 +2223,7 @@ public class Resolve {
/**
* A name designates an operator if it consists
* of a non-empty sequence of operator symbols +-~!/*%&|^<>=
* of a non-empty sequence of operator symbols {@literal +-~!/*%&|^<>= }
*/
boolean isOperator(Name name) {
int i = 0;

4
langtools/src/share/classes/com/sun/tools/javac/jvm/ByteCodes.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1999, 2005, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1999, 2012, 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
@ -277,7 +277,7 @@ public interface ByteCodes {
/** Shift and mask constants for shifting prefix instructions.
* a pair of instruction codes such as LCMP ; IFEQ is encoded
* in Symtab as (LCMP << preShift) + IFEQ.
* in Symtab as {@literal (LCMP << preShift) + IFEQ }.
*/
int preShift = 9;
int preMask = (1 << preShift) - 1;

2
langtools/src/share/classes/com/sun/tools/javac/jvm/CRTable.java
View file

@ -162,7 +162,7 @@ implements CRTFlags {
}
/** Source file positions in CRT are integers in the format:
* line-number << LINESHIFT + column-number
* {@literal line-number << LINESHIFT + column-number }
*/
private int encodePosition(int pos, Position.LineMap lineMap, Log log) {
int line = lineMap.getLineNumber(pos);

6
langtools/src/share/classes/com/sun/tools/javac/jvm/ClassFile.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1999, 2012, 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
@ -45,7 +45,7 @@ import com.sun.tools.javac.util.Name;
* classSignature ::= [ typeparams ] supertype { interfacetype }
* </pre>
* <p>The type syntax in signatures is extended as follows:
* <pre>
* <pre>{@literal
* type ::= ... | classtype | methodtype | typevar
* classtype ::= classsig { '.' classsig }
* classig ::= 'L' name [typeargs] ';'
@ -54,7 +54,7 @@ import com.sun.tools.javac.util.Name;
* typeargs ::= '<' type { type } '>'
* typeparams ::= '<' typeparam { typeparam } '>'
* typeparam ::= name ':' type
* </pre>
* }</pre>
* <p>This class defines constants used in class files as well
* as routines to convert between internal ``.'' and external ``/''
* separators in class names.

15
langtools/src/share/classes/com/sun/tools/javac/jvm/Code.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1999, 2012, 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
@ -122,7 +122,7 @@ public class Code {
/*---------- internal fields: --------------- */
/** Are we generating code with jumps >= 32K?
/** Are we generating code with jumps &ge; 32K?
*/
public boolean fatcode;
@ -1077,13 +1077,15 @@ public class Code {
while (cp % incr != 0) emitop0(nop);
}
/** Place a byte into code at address pc. Pre: pc + 1 <= cp.
/** Place a byte into code at address pc.
* Pre: {@literal pc + 1 <= cp }.
*/
private void put1(int pc, int op) {
code[pc] = (byte)op;
}
/** Place two bytes into code at address pc. Pre: pc + 2 <= cp.
/** Place two bytes into code at address pc.
* Pre: {@literal pc + 2 <= cp }.
*/
private void put2(int pc, int od) {
// pre: pc + 2 <= cp
@ -1091,7 +1093,8 @@ public class Code {
put1(pc+1, od);
}
/** Place four bytes into code at address pc. Pre: pc + 4 <= cp.
/** Place four bytes into code at address pc.
* Pre: {@literal pc + 4 <= cp }.
*/
public void put4(int pc, int od) {
// pre: pc + 4 <= cp
@ -1990,7 +1993,7 @@ public class Code {
nextreg = max_locals;
}
/** End scopes of all variables with registers >= first.
/** End scopes of all variables with registers &ge; first.
*/
public void endScopes(int first) {
int prevNextReg = nextreg;

4
langtools/src/share/classes/com/sun/tools/javac/jvm/Gen.java
View file

@ -247,10 +247,10 @@ public class Gen extends JCTree.Visitor {
/** Construct a symbol to reflect the qualifying type that should
* appear in the byte code as per JLS 13.1.
*
* For target >= 1.2: Clone a method with the qualifier as owner (except
* For {@literal target >= 1.2}: Clone a method with the qualifier as owner (except
* for those cases where we need to work around VM bugs).
*
* For target <= 1.1: If qualified variable or method is defined in a
* For {@literal target <= 1.1}: If qualified variable or method is defined in a
* non-accessible class, clone it with the qualifier class as owner.
*
* @param sym The accessed symbol

29
langtools/src/share/classes/com/sun/tools/javac/parser/JavacParser.java
View file

@ -670,6 +670,7 @@ public class JavacParser implements Parser {
}
/**
* {@literal
* Expression = Expression1 [ExpressionRest]
* ExpressionRest = [AssignmentOperator Expression1]
* AssignmentOperator = "=" | "+=" | "-=" | "*=" | "/=" |
@ -679,6 +680,7 @@ public class JavacParser implements Parser {
* TypeNoParams = TypeNoParams1
* StatementExpression = Expression
* ConstantExpression = Expression
* }
*/
JCExpression term() {
JCExpression t = term1();
@ -884,9 +886,12 @@ public class JavacParser implements Parser {
return opStack;
}
/** Expression3 = PrefixOp Expression3
/**
* Expression3 = PrefixOp Expression3
* | "(" Expr | TypeNoParams ")" Expression3
* | Primary {Selector} {PostfixOp}
*
* {@literal
* Primary = "(" Expression ")"
* | Literal
* | [TypeArguments] THIS [Arguments]
@ -901,6 +906,8 @@ public class JavacParser implements Parser {
* | "." ( CLASS | THIS | [TypeArguments] SUPER Arguments | NEW [TypeArguments] InnerCreator )
* ]
* | BasicType BracketsOpt "." CLASS
* }
*
* PrefixOp = "++" | "--" | "!" | "~" | "+" | "-"
* PostfixOp = "++" | "--"
* Type3 = Ident { "." Ident } [TypeArguments] {TypeSelector} BracketsOpt
@ -1453,7 +1460,10 @@ public class JavacParser implements Parser {
return null;
}
/** TypeArguments = "<" TypeArgument {"," TypeArgument} ">"
/**
* {@literal
* TypeArguments = "<" TypeArgument {"," TypeArgument} ">"
* }
*/
List<JCExpression> typeArguments(boolean diamondAllowed) {
if (token.kind == LT) {
@ -1490,10 +1500,13 @@ public class JavacParser implements Parser {
}
}
/** TypeArgument = Type
/**
* {@literal
* TypeArgument = Type
* | "?"
* | "?" EXTENDS Type {"&" Type}
* | "?" SUPER Type
* }
*/
JCExpression typeArgument() {
if (token.kind != QUES) return parseType();
@ -2991,7 +3004,10 @@ public class JavacParser implements Parser {
return ts.toList();
}
/** TypeParametersOpt = ["<" TypeParameter {"," TypeParameter} ">"]
/**
* {@literal
* TypeParametersOpt = ["<" TypeParameter {"," TypeParameter} ">"]
* }
*/
List<JCTypeParameter> typeParametersOpt() {
if (token.kind == LT) {
@ -3010,9 +3026,12 @@ public class JavacParser implements Parser {
}
}
/** TypeParameter = TypeVariable [TypeParameterBound]
/**
* {@literal
* TypeParameter = TypeVariable [TypeParameterBound]
* TypeParameterBound = EXTENDS Type {"&" Type}
* TypeVariable = Ident
* }
*/
JCTypeParameter typeParameter() {
int pos = token.pos;

5
langtools/src/share/classes/com/sun/tools/javac/parser/Lexer.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2005, 2012, 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
@ -61,7 +61,8 @@ public interface Lexer {
/**
* Splits the current token in two and return the first (splitted) token.
* For instance '<<<' is splitted into two tokens '<' and '<<' respectively,
* For instance {@literal '<<<'} is split into two tokens
* {@literal '<'} and {@literal '<<'} respectively,
* and the latter is returned.
*/
Token split();

3
langtools/src/share/classes/com/sun/tools/javac/processing/JavacProcessingEnvironment.java
View file

@ -1364,7 +1364,8 @@ public class JavacProcessingEnvironment implements ProcessingEnvironment, Closea
* {@inheritdoc}
*
* Command line options suitable for presenting to annotation
* processors. "-Afoo=bar" should be "-Afoo" => "bar".
* processors.
* {@literal "-Afoo=bar"} should be {@literal "-Afoo" => "bar"}.
*/
public Map<String,String> getOptions() {
return processorOptions;

2
langtools/src/share/classes/com/sun/tools/javac/tree/JCTree.java
View file

@ -2010,7 +2010,7 @@ public abstract class JCTree implements Tree, Cloneable, DiagnosticPosition {
}
/**
* A parameterized type, T<...>
* A parameterized type, {@literal T<...>}
*/
public static class JCTypeApply extends JCExpression implements ParameterizedTypeTree {
public JCExpression clazz;

3
langtools/src/share/classes/com/sun/tools/javac/tree/Pretty.java
View file

@ -256,7 +256,8 @@ public class Pretty extends JCTree.Visitor {
return pos;
}
/** If type parameter list is non-empty, print it enclosed in "<...>" brackets.
/** If type parameter list is non-empty, print it enclosed in
* {@literal "<...>"} brackets.
*/
public void printTypeParameters(List<JCTypeParameter> trees) throws IOException {
if (trees.nonEmpty()) {

10
langtools/src/share/classes/com/sun/tools/javac/util/Bits.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1999, 2012, 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
@ -127,7 +127,7 @@ public class Bits {
(bits[x >>> wordshift] & (1 << (x & wordmask))) != 0;
}
/** this set = this set & xs.
/** {@literal this set = this set & xs}.
*/
public Bits andSet(Bits xs) {
sizeTo(xs.bits.length);
@ -179,12 +179,12 @@ public class Bits {
return n - (x&1);
}
/** Return the index of the least bit position >= x that is set.
/** Return the index of the least bit position &ge; x that is set.
* If none are set, returns -1. This provides a nice way to iterate
* over the members of a bit set:
* <pre>
* <pre>{@code
* for (int i = bits.nextBit(0); i>=0; i = bits.nextBit(i+1)) ...
* </pre>
* }</pre>
*/
public int nextBit(int x) {
int windex = x >>> wordshift;

7
langtools/src/share/classes/com/sun/tools/javac/util/Context.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2001, 2012, 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
@ -115,7 +115,10 @@ public class Context {
* The underlying map storing the data.
* We maintain the invariant that this table contains only
* mappings of the form
* Key<T> -> T or Key<T> -> Factory<T> */
* {@literal Key<T> -> T }
* or
* {@literal Key<T> -> Factory<T> }
*/
private Map<Key<?>,Object> ht = new HashMap<Key<?>,Object>();
/** Set the factory for the key in this context. */

11
langtools/src/share/classes/com/sun/tools/javac/util/Name.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1999, 2008, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1999, 2012, 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
@ -43,28 +43,28 @@ public abstract class Name implements javax.lang.model.element.Name {
}
/**
* @inheritDoc
* {@inheritDoc}
*/
public boolean contentEquals(CharSequence cs) {
return toString().equals(cs.toString());
}
/**
* @inheritDoc
* {@inheritDoc}
*/
public int length() {
return toString().length();
}
/**
* @inheritDoc
* {@inheritDoc}
*/
public char charAt(int index) {
return toString().charAt(index);
}
/**
* @inheritDoc
* {@inheritDoc}
*/
public CharSequence subSequence(int start, int end) {
return toString().subSequence(start, end);
@ -142,6 +142,7 @@ public abstract class Name implements javax.lang.model.element.Name {
/** Return the string representation of this name.
*/
@Override
public String toString() {
return Convert.utf2string(getByteArray(), getByteOffset(), getByteLength());
}

16
langtools/src/share/classes/com/sun/tools/javac/util/Position.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1999, 2006, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1999, 2012, 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
@ -79,12 +79,12 @@ public class Position {
}
/** Encode line and column numbers in an integer as:
* line-number << LINESHIFT + column-number
* {@link Position.NOPOS represents an undefined position.
* {@code line-number << LINESHIFT + column-number }.
* {@link Position.NOPOS} represents an undefined position.
*
* @param line number of line (first is 1)
* @param col number of character on line (first is 1)
* @return an encoded position or {@link Position.NOPOS
* @return an encoded position or {@link Position.NOPOS}
* if the line or column number is too big to
* represent in the encoded format
* @throws IllegalArgumentException if line or col is less than 1
@ -107,8 +107,8 @@ public class Position {
* @param line number of line (first is 1)
* @return position of first character in line
* @throws ArrayIndexOutOfBoundsException
* if <tt>lineNumber < 1</tt>
* if <tt>lineNumber > no. of lines</tt>
* if {@code lineNumber < 1}
* if {@code lineNumber > no. of lines}
*/
int getStartPosition(int line);
@ -119,8 +119,8 @@ public class Position {
*
* @return position of character
* @throws ArrayIndexOutOfBoundsException
* if <tt>line < 1</tt>
* if <tt>line > no. of lines</tt>
* if {@code line < 1}
* if {@code line > no. of lines}
*/
int getPosition(int line, int column);

4
langtools/src/share/classes/com/sun/tools/javadoc/Comment.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2012, 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
@ -386,7 +386,7 @@ class Comment {
}
/**
* Recursively search for the string "{@" followed by
* Recursively search for the characters '{', '@', followed by
* name of inline tag and white space,
* if found
* return the index of the text following the white space.

4
langtools/src/share/classes/com/sun/tools/javadoc/DocImpl.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2012, 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
@ -138,7 +138,7 @@ public abstract class DocImpl implements Doc, Comparable<Object> {
/**
* Return the see also tags in this Doc item.
*
* @return an array of SeeTag containing all &#64see tags.
* @return an array of SeeTag containing all &#64;see tags.
*/
public SeeTag[] seeTags() {
return comment().seeTags();

4
langtools/src/share/classes/com/sun/tools/javadoc/FieldDocImpl.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2012, 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
@ -241,7 +241,7 @@ public class FieldDocImpl extends MemberDocImpl implements FieldDoc {
* Return the serialField tags in this FieldDocImpl item.
*
* @return an array of <tt>SerialFieldTagImpl</tt> containing all
* <code>&#64serialField</code> tags.
* <code>&#64;serialField</code> tags.
*/
public SerialFieldTag[] serialFieldTags() {
return comment().serialFieldTags();

2
langtools/src/share/classes/com/sun/tools/javah/JavahTask.java
View file

@ -79,7 +79,7 @@ import com.sun.tools.javac.main.CommandLine;
/**
* Javah generates support files for native methods.
* Parse commandline options & Invokes javadoc to execute those commands.
* Parse commandline options and invokes javadoc to execute those commands.
*
* <p><b>This is NOT part of any supported API.
* If you write code that depends on this, you do so at your own

6
langtools/src/share/classes/javax/lang/model/util/Elements.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2005, 2012, 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
@ -79,12 +79,12 @@ public interface Elements {
*
* <p> A documentation comment of an element is a comment that
* begins with "{@code /**}" , ends with a separate
* "<code>*&#47</code>", and immediately precedes the element,
* "<code>*&#47;</code>", and immediately precedes the element,
* ignoring white space. Therefore, a documentation comment
* contains at least three"{@code *}" characters. The text
* returned for the documentation comment is a processed form of
* the comment as it appears in source code. The leading "{@code
* /**}" and trailing "<code>*&#47</code>" are removed. For lines
* /**}" and trailing "<code>*&#47;</code>" are removed. For lines
* of the comment starting after the initial "{@code /**}",
* leading white space characters are discarded as are any
* consecutive "{@code *}" characters appearing after the white

4
langtools/src/share/classes/javax/tools/JavaCompiler.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2005, 2012, 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
@ -137,7 +137,7 @@ import javax.annotation.processing.Processor;
* StandardJavaFileManager fileManager = compiler.getStandardFileManager(diagnostics, null, null);
* compiler.getTask(null, fileManager, diagnostics, null, null, compilationUnits).call();
*
* for (Diagnostic<? extends JavaFileObject> diagnostic : diagnostics.getDiagnostics())
* for ({@code Diagnostic<? extends JavaFileObject>} diagnostic : diagnostics.getDiagnostics())
* System.out.format("Error on line %d in %s%n",
* diagnostic.getLineNumber(),
* diagnostic.getSource().toUri());