Mercurial > jdk8-mips64-public > langtools / changeset
changeset
7177970: fix issues in langtools doc comments
Thu, 13 Sep 2012 14:29:36 -0700
- author
- jjg
- date
- Thu, 13 Sep 2012 14:29:36 -0700
- changeset 1326
- 30c36e23f154
- parent 1325
- b2064a216117
- child 1327
- fabfd2710057
- child 1328
- 8c3c714eb7de
7177970: fix issues in langtools doc comments
Reviewed-by: mcimadamore
1.1 --- a/src/share/classes/com/sun/javadoc/Doc.java Sat Sep 08 22:54:21 2012 -0700 1.2 +++ b/src/share/classes/com/sun/javadoc/Doc.java Thu Sep 13 14:29:36 2012 -0700 1.3 @@ -1,5 +1,5 @@ 1.4 /* 1.5 - * Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved. 1.6 + * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved. 1.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 1.8 * 1.9 * This code is free software; you can redistribute it and/or modify it 1.10 @@ -76,7 +76,7 @@ 1.11 1.12 /** 1.13 * Return comment as an array of tags. Includes inline tags 1.14 - * (i.e. {@link <i>reference</i>} tags) but not 1.15 + * (i.e. {@link <i>reference</i>} tags) but not 1.16 * block tags. 1.17 * Each section of plain text is represented as a {@link Tag} 1.18 * of {@linkplain Tag#kind() kind} "Text". 1.19 @@ -90,7 +90,7 @@ 1.20 /** 1.21 * Return the first sentence of the comment as an array of tags. 1.22 * Includes inline tags 1.23 - * (i.e. {@link <i>reference</i>} tags) but not 1.24 + * (i.e. {@link <i>reference</i>} tags) but not 1.25 * block tags. 1.26 * Each section of plain text is represented as a {@link Tag} 1.27 * of {@linkplain Tag#kind() kind} "Text".
2.1 --- a/src/share/classes/com/sun/javadoc/ExecutableMemberDoc.java Sat Sep 08 22:54:21 2012 -0700 2.2 +++ b/src/share/classes/com/sun/javadoc/ExecutableMemberDoc.java Thu Sep 13 14:29:36 2012 -0700 2.3 @@ -1,5 +1,5 @@ 2.4 /* 2.5 - * Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved. 2.6 + * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved. 2.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 2.8 * 2.9 * This code is free software; you can redistribute it and/or modify it 2.10 @@ -90,8 +90,8 @@ 2.11 /** 2.12 * Return the throws tags in this method. 2.13 * 2.14 - * @return an array of ThrowTag containing all <code>@exception</code> 2.15 - * and <code>@throws</code> tags. 2.16 + * @return an array of ThrowTag containing all <code>@exception</code> 2.17 + * and <code>@throws</code> tags. 2.18 */ 2.19 ThrowsTag[] throwsTags(); 2.20 2.21 @@ -99,7 +99,7 @@ 2.22 * Return the param tags in this method, excluding the type 2.23 * parameter tags. 2.24 * 2.25 - * @return an array of ParamTag containing all <code>@param</code> tags 2.26 + * @return an array of ParamTag containing all <code>@param</code> tags 2.27 * corresponding to the parameters of this method. 2.28 */ 2.29 ParamTag[] paramTags(); 2.30 @@ -107,7 +107,7 @@ 2.31 /** 2.32 * Return the type parameter tags in this method. 2.33 * 2.34 - * @return an array of ParamTag containing all <code>@param</code> tags 2.35 + * @return an array of ParamTag containing all <code>@param</code> tags 2.36 * corresponding to the type parameters of this method. 2.37 * @since 1.5 2.38 */
3.1 --- a/src/share/classes/com/sun/javadoc/Tag.java Sat Sep 08 22:54:21 2012 -0700 3.2 +++ b/src/share/classes/com/sun/javadoc/Tag.java Thu Sep 13 14:29:36 2012 -0700 3.3 @@ -1,5 +1,5 @@ 3.4 /* 3.5 - * Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved. 3.6 + * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved. 3.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 3.8 * 3.9 * This code is free software; you can redistribute it and/or modify it 3.10 @@ -127,7 +127,7 @@ 3.11 /** 3.12 * Return the first sentence of the comment as an array of tags. 3.13 * Includes inline tags 3.14 - * (i.e. {@link <i>reference</i>} tags) but not 3.15 + * (i.e. {@link <i>reference</i>} tags) but not 3.16 * block tags. 3.17 * Each section of plain text is represented as a {@link Tag} 3.18 * of kind "Text".
4.1 --- a/src/share/classes/com/sun/source/tree/LambdaExpressionTree.java Sat Sep 08 22:54:21 2012 -0700 4.2 +++ b/src/share/classes/com/sun/source/tree/LambdaExpressionTree.java Thu Sep 13 14:29:36 2012 -0700 4.3 @@ -1,5 +1,5 @@ 4.4 /* 4.5 - * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved. 4.6 + * Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved. 4.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4.8 * 4.9 * This code is free software; you can redistribute it and/or modify it 4.10 @@ -31,11 +31,11 @@ 4.11 * A tree node for a lambda expression. 4.12 * 4.13 * For example: 4.14 - * <pre> 4.15 + * <pre>{@code 4.16 * ()->{} 4.17 * (List<String> ls)->ls.size() 4.18 * (x,y)-> { return x + y; } 4.19 - * </pre> 4.20 + * }</pre> 4.21 */ 4.22 public interface LambdaExpressionTree extends ExpressionTree { 4.23
5.1 --- a/src/share/classes/com/sun/source/tree/LineMap.java Sat Sep 08 22:54:21 2012 -0700 5.2 +++ b/src/share/classes/com/sun/source/tree/LineMap.java Thu Sep 13 14:29:36 2012 -0700 5.3 @@ -1,5 +1,5 @@ 5.4 /* 5.5 - * Copyright (c) 2006, Oracle and/or its affiliates. All rights reserved. 5.6 + * Copyright (c) 2006, 2012, Oracle and/or its affiliates. All rights reserved. 5.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 5.8 * 5.9 * This code is free software; you can redistribute it and/or modify it 5.10 @@ -38,8 +38,8 @@ 5.11 * @param line line number (beginning at 1) 5.12 * @return position of first character in line 5.13 * @throws IndexOutOfBoundsException 5.14 - * if <tt>lineNumber < 1</tt> 5.15 - * if <tt>lineNumber > no. of lines</tt> 5.16 + * if {@code lineNumber < 1} 5.17 + * if {@code lineNumber > no. of lines} 5.18 */ 5.19 long getStartPosition(long line); 5.20
6.1 --- a/src/share/classes/com/sun/source/util/TreeScanner.java Sat Sep 08 22:54:21 2012 -0700 6.2 +++ b/src/share/classes/com/sun/source/util/TreeScanner.java Thu Sep 13 14:29:36 2012 -0700 6.3 @@ -1,5 +1,5 @@ 6.4 /* 6.5 - * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. 6.6 + * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. 6.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 6.8 * 6.9 * This code is free software; you can redistribute it and/or modify it 6.10 @@ -52,7 +52,7 @@ 6.11 * 6.12 * <p>Here is an example to count the number of identifier nodes in a tree: 6.13 * <pre> 6.14 - * class CountIdentifiers extends TreeScanner<Integer,Void> { 6.15 + * class CountIdentifiers extends TreeScanner<Integer,Void> { 6.16 * {@literal @}Override 6.17 * public Integer visitIdentifier(IdentifierTree node, Void p) { 6.18 * return 1;
7.1 --- a/src/share/classes/com/sun/tools/doclets/formats/html/HtmlDocletWriter.java Sat Sep 08 22:54:21 2012 -0700 7.2 +++ b/src/share/classes/com/sun/tools/doclets/formats/html/HtmlDocletWriter.java Thu Sep 13 14:29:36 2012 -0700 7.3 @@ -1,5 +1,5 @@ 7.4 /* 7.5 - * Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved. 7.6 + * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved. 7.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 7.8 * 7.9 * This code is free software; you can redistribute it and/or modify it 7.10 @@ -1260,7 +1260,7 @@ 7.11 /** 7.12 * Print the Html table tag for the index summary tables. The table tag 7.13 * printed is 7.14 - * <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> 7.15 + * {@code <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> } 7.16 */ 7.17 public void tableIndexSummary() { 7.18 table(1, "100%", 3, 0); 7.19 @@ -1548,7 +1548,7 @@ 7.20 } 7.21 7.22 /** 7.23 - * Print the heading in Html <H2> format. 7.24 + * Print the heading in Html {@literal <H2>} format. 7.25 * 7.26 * @param str The Header string. 7.27 */ 7.28 @@ -2416,15 +2416,15 @@ 7.29 * <p> 7.30 * Here is the algorithm used to fix the link: 7.31 * <p> 7.32 - * <relative link> => docRoot + <relative path to file> + <relative link> 7.33 + * {@literal <relative link> => docRoot + <relative path to file> + <relative link> } 7.34 * <p> 7.35 * For example, suppose com.sun.javadoc.RootDoc has this link: 7.36 - * <a href="package-summary.html">The package Page</a> 7.37 + * {@literal <a href="package-summary.html">The package Page</a> } 7.38 * <p> 7.39 * If this link appeared in the index, we would redirect 7.40 * the link like this: 7.41 * 7.42 - * <a href="./com/sun/javadoc/package-summary.html">The package Page</a> 7.43 + * {@literal <a href="./com/sun/javadoc/package-summary.html">The package Page</a>} 7.44 * 7.45 * @param doc the Doc object whose documentation is being written. 7.46 * @param text the text being written.
8.1 --- a/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/ClassBuilder.java Sat Sep 08 22:54:21 2012 -0700 8.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/ClassBuilder.java Thu Sep 13 14:29:36 2012 -0700 8.3 @@ -1,5 +1,5 @@ 8.4 /* 8.5 - * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved. 8.6 + * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved. 8.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 8.8 * 8.9 * This code is free software; you can redistribute it and/or modify it 8.10 @@ -125,7 +125,7 @@ 8.11 } 8.12 8.13 /** 8.14 - * Handles the <ClassDoc> tag. 8.15 + * Handles the {@literal <ClassDoc>} tag. 8.16 * 8.17 * @param node the XML element that specifies which components to document 8.18 * @param contentTree the content tree to which the documentation will be added
9.1 --- a/src/share/classes/com/sun/tools/javac/code/Symtab.java Sat Sep 08 22:54:21 2012 -0700 9.2 +++ b/src/share/classes/com/sun/tools/javac/code/Symtab.java Thu Sep 13 14:29:36 2012 -0700 9.3 @@ -251,7 +251,8 @@ 9.4 } 9.5 9.6 /** Enter a binary operation, as above but with two opcodes, 9.7 - * which get encoded as (opcode1 << ByteCodeTags.preShift) + opcode2. 9.8 + * which get encoded as 9.9 + * {@code (opcode1 << ByteCodeTags.preShift) + opcode2 }. 9.10 * @param opcode1 First opcode. 9.11 * @param opcode2 Second opcode. 9.12 */
10.1 --- a/src/share/classes/com/sun/tools/javac/code/Type.java Sat Sep 08 22:54:21 2012 -0700 10.2 +++ b/src/share/classes/com/sun/tools/javac/code/Type.java Thu Sep 13 14:29:36 2012 -0700 10.3 @@ -692,7 +692,7 @@ 10.4 /** A class type is raw if it misses some 10.5 * of its type parameter sections. 10.6 * After validation, this is equivalent to: 10.7 - * allparams.isEmpty() && tsym.type.allparams.nonEmpty(); 10.8 + * {@code allparams.isEmpty() && tsym.type.allparams.nonEmpty(); } 10.9 */ 10.10 public boolean isRaw() { 10.11 return
11.1 --- a/src/share/classes/com/sun/tools/javac/comp/Check.java Sat Sep 08 22:54:21 2012 -0700 11.2 +++ b/src/share/classes/com/sun/tools/javac/comp/Check.java Thu Sep 13 14:29:36 2012 -0700 11.3 @@ -2373,9 +2373,12 @@ 11.4 tree.accept(new AnnotationValidator()); 11.5 } 11.6 11.7 - /** Annotation types are restricted to primitives, String, an 11.8 + /** 11.9 + * {@literal 11.10 + * Annotation types are restricted to primitives, String, an 11.11 * enum, an annotation, Class, Class<?>, Class<? extends 11.12 * Anything>, arrays of the preceding. 11.13 + * } 11.14 */ 11.15 void validateAnnotationType(JCTree restype) { 11.16 // restype may be null if an error occurred, so don't bother validating it
12.1 --- a/src/share/classes/com/sun/tools/javac/comp/Enter.java Sat Sep 08 22:54:21 2012 -0700 12.2 +++ b/src/share/classes/com/sun/tools/javac/comp/Enter.java Thu Sep 13 14:29:36 2012 -0700 12.3 @@ -77,12 +77,12 @@ 12.4 * 12.5 * <p>Classes migrate from one phase to the next via queues: 12.6 * 12.7 - * <pre> 12.8 + * <pre>{@literal 12.9 * class enter -> (Enter.uncompleted) --> member enter (1) 12.10 * -> (MemberEnter.halfcompleted) --> member enter (2) 12.11 * -> (Todo) --> attribute 12.12 * (only for toplevel classes) 12.13 - * </pre> 12.14 + * }</pre> 12.15 * 12.16 * <p><b>This is NOT part of any supported API. 12.17 * If you write code that depends on this, you do so at your own risk.
13.1 --- a/src/share/classes/com/sun/tools/javac/comp/Lower.java Sat Sep 08 22:54:21 2012 -0700 13.2 +++ b/src/share/classes/com/sun/tools/javac/comp/Lower.java Thu Sep 13 14:29:36 2012 -0700 13.3 @@ -1449,7 +1449,7 @@ 13.4 return access(v, make.at(pos).Ident(v), null, false); 13.5 } 13.6 13.7 - /** Construct a tree simulating the expression <C.this>. 13.8 + /** Construct a tree simulating the expression {@code C.this}. 13.9 * @param pos The source code position to be used for the tree. 13.10 * @param c The qualifier class. 13.11 */ 13.12 @@ -1623,7 +1623,7 @@ 13.13 } 13.14 13.15 /** Construct a tree that represents the outer instance 13.16 - * <C.this>. Never pick the current `this'. 13.17 + * {@code C.this}. Never pick the current `this'. 13.18 * @param pos The source code position to be used for the tree. 13.19 * @param c The qualifier class. 13.20 */ 13.21 @@ -1661,7 +1661,7 @@ 13.22 } 13.23 13.24 /** Construct a tree that represents the closest outer instance 13.25 - * <C.this> such that the given symbol is a member of C. 13.26 + * {@code C.this} such that the given symbol is a member of C. 13.27 * @param pos The source code position to be used for the tree. 13.28 * @param sym The accessed symbol. 13.29 * @param preciseMatch should we accept a type that is a subtype of 13.30 @@ -1713,7 +1713,7 @@ 13.31 return tree; 13.32 } 13.33 13.34 - /** Return tree simulating the assignment <this.name = name>, where 13.35 + /** Return tree simulating the assignment {@code this.name = name}, where 13.36 * name is the name of a free variable. 13.37 */ 13.38 JCStatement initField(int pos, Name name) { 13.39 @@ -1730,7 +1730,7 @@ 13.40 make.Ident(rhs)).setType(lhs.erasure(types))); 13.41 } 13.42 13.43 - /** Return tree simulating the assignment <this.this$n = this$n>. 13.44 + /** Return tree simulating the assignment {@code this.this$n = this$n}. 13.45 */ 13.46 JCStatement initOuterThis(int pos) { 13.47 VarSymbol rhs = outerThisStack.head; 13.48 @@ -3194,7 +3194,7 @@ 13.49 * 13.50 * (where arrayexpr is of an array type) gets translated to 13.51 * 13.52 - * <pre> 13.53 + * <pre>{@code 13.54 * for ( { arraytype #arr = arrayexpr; 13.55 * int #len = array.length; 13.56 * int #i = 0; }; 13.57 @@ -3202,7 +3202,7 @@ 13.58 * T v = arr$[#i]; 13.59 * stmt; 13.60 * } 13.61 - * </pre> 13.62 + * }</pre> 13.63 * 13.64 * where #arr, #len, and #i are freshly named synthetic local variables. 13.65 */ 13.66 @@ -3272,14 +3272,14 @@ 13.67 * for ( T v : coll ) stmt ; 13.68 * </pre> 13.69 * 13.70 - * (where coll implements Iterable<? extends T>) gets translated to 13.71 + * (where coll implements {@code Iterable<? extends T>}) gets translated to 13.72 * 13.73 - * <pre> 13.74 + * <pre>{@code 13.75 * for ( Iterator<? extends T> #i = coll.iterator(); #i.hasNext(); ) { 13.76 * T v = (T) #i.next(); 13.77 * stmt; 13.78 * } 13.79 - * </pre> 13.80 + * }</pre> 13.81 * 13.82 * where #i is a freshly named synthetic local variable. 13.83 */
14.1 --- a/src/share/classes/com/sun/tools/javac/comp/Resolve.java Sat Sep 08 22:54:21 2012 -0700 14.2 +++ b/src/share/classes/com/sun/tools/javac/comp/Resolve.java Thu Sep 13 14:29:36 2012 -0700 14.3 @@ -1516,7 +1516,7 @@ 14.4 /** If `sym' is a bad symbol: report error and return errSymbol 14.5 * else pass through unchanged, 14.6 * additional arguments duplicate what has been used in trying to find the 14.7 - * symbol (--> flyweight pattern). This improves performance since we 14.8 + * symbol {@literal (--> flyweight pattern)}. This improves performance since we 14.9 * expect misses to happen frequently. 14.10 * 14.11 * @param sym The symbol that was found, or a ResolveError. 14.12 @@ -1903,9 +1903,9 @@ 14.13 14.14 /** This method scans all the constructor symbol in a given class scope - 14.15 * assuming that the original scope contains a constructor of the kind: 14.16 - * Foo(X x, Y y), where X,Y are class type-variables declared in Foo, 14.17 + * {@code Foo(X x, Y y)}, where X,Y are class type-variables declared in Foo, 14.18 * a method check is executed against the modified constructor type: 14.19 - * <X,Y>Foo<X,Y>(X x, Y y). This is crucial in order to enable diamond 14.20 + * {@code <X,Y>Foo<X,Y>(X x, Y y)}. This is crucial in order to enable diamond 14.21 * inference. The inferred return type of the synthetic constructor IS 14.22 * the inferred type for the diamond operator. 14.23 */ 14.24 @@ -2223,7 +2223,7 @@ 14.25 14.26 /** 14.27 * A name designates an operator if it consists 14.28 - * of a non-empty sequence of operator symbols +-~!/*%&|^<>= 14.29 + * of a non-empty sequence of operator symbols {@literal +-~!/*%&|^<>= } 14.30 */ 14.31 boolean isOperator(Name name) { 14.32 int i = 0;
15.1 --- a/src/share/classes/com/sun/tools/javac/jvm/ByteCodes.java Sat Sep 08 22:54:21 2012 -0700 15.2 +++ b/src/share/classes/com/sun/tools/javac/jvm/ByteCodes.java Thu Sep 13 14:29:36 2012 -0700 15.3 @@ -1,5 +1,5 @@ 15.4 /* 15.5 - * Copyright (c) 1999, 2005, Oracle and/or its affiliates. All rights reserved. 15.6 + * Copyright (c) 1999, 2012, Oracle and/or its affiliates. All rights reserved. 15.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 15.8 * 15.9 * This code is free software; you can redistribute it and/or modify it 15.10 @@ -277,7 +277,7 @@ 15.11 15.12 /** Shift and mask constants for shifting prefix instructions. 15.13 * a pair of instruction codes such as LCMP ; IFEQ is encoded 15.14 - * in Symtab as (LCMP << preShift) + IFEQ. 15.15 + * in Symtab as {@literal (LCMP << preShift) + IFEQ }. 15.16 */ 15.17 int preShift = 9; 15.18 int preMask = (1 << preShift) - 1;
16.1 --- a/src/share/classes/com/sun/tools/javac/jvm/CRTable.java Sat Sep 08 22:54:21 2012 -0700 16.2 +++ b/src/share/classes/com/sun/tools/javac/jvm/CRTable.java Thu Sep 13 14:29:36 2012 -0700 16.3 @@ -162,7 +162,7 @@ 16.4 } 16.5 16.6 /** Source file positions in CRT are integers in the format: 16.7 - * line-number << LINESHIFT + column-number 16.8 + * {@literal line-number << LINESHIFT + column-number } 16.9 */ 16.10 private int encodePosition(int pos, Position.LineMap lineMap, Log log) { 16.11 int line = lineMap.getLineNumber(pos);
17.1 --- a/src/share/classes/com/sun/tools/javac/jvm/ClassFile.java Sat Sep 08 22:54:21 2012 -0700 17.2 +++ b/src/share/classes/com/sun/tools/javac/jvm/ClassFile.java Thu Sep 13 14:29:36 2012 -0700 17.3 @@ -1,5 +1,5 @@ 17.4 /* 17.5 - * Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved. 17.6 + * Copyright (c) 1999, 2012, Oracle and/or its affiliates. All rights reserved. 17.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 17.8 * 17.9 * This code is free software; you can redistribute it and/or modify it 17.10 @@ -45,7 +45,7 @@ 17.11 * classSignature ::= [ typeparams ] supertype { interfacetype } 17.12 * </pre> 17.13 * <p>The type syntax in signatures is extended as follows: 17.14 - * <pre> 17.15 + * <pre>{@literal 17.16 * type ::= ... | classtype | methodtype | typevar 17.17 * classtype ::= classsig { '.' classsig } 17.18 * classig ::= 'L' name [typeargs] ';' 17.19 @@ -54,7 +54,7 @@ 17.20 * typeargs ::= '<' type { type } '>' 17.21 * typeparams ::= '<' typeparam { typeparam } '>' 17.22 * typeparam ::= name ':' type 17.23 - * </pre> 17.24 + * }</pre> 17.25 * <p>This class defines constants used in class files as well 17.26 * as routines to convert between internal ``.'' and external ``/'' 17.27 * separators in class names.
18.1 --- a/src/share/classes/com/sun/tools/javac/jvm/Code.java Sat Sep 08 22:54:21 2012 -0700 18.2 +++ b/src/share/classes/com/sun/tools/javac/jvm/Code.java Thu Sep 13 14:29:36 2012 -0700 18.3 @@ -1,5 +1,5 @@ 18.4 /* 18.5 - * Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved. 18.6 + * Copyright (c) 1999, 2012, Oracle and/or its affiliates. All rights reserved. 18.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 18.8 * 18.9 * This code is free software; you can redistribute it and/or modify it 18.10 @@ -122,7 +122,7 @@ 18.11 18.12 /*---------- internal fields: --------------- */ 18.13 18.14 - /** Are we generating code with jumps >= 32K? 18.15 + /** Are we generating code with jumps ≥ 32K? 18.16 */ 18.17 public boolean fatcode; 18.18 18.19 @@ -1077,13 +1077,15 @@ 18.20 while (cp % incr != 0) emitop0(nop); 18.21 } 18.22 18.23 - /** Place a byte into code at address pc. Pre: pc + 1 <= cp. 18.24 + /** Place a byte into code at address pc. 18.25 + * Pre: {@literal pc + 1 <= cp }. 18.26 */ 18.27 private void put1(int pc, int op) { 18.28 code[pc] = (byte)op; 18.29 } 18.30 18.31 - /** Place two bytes into code at address pc. Pre: pc + 2 <= cp. 18.32 + /** Place two bytes into code at address pc. 18.33 + * Pre: {@literal pc + 2 <= cp }. 18.34 */ 18.35 private void put2(int pc, int od) { 18.36 // pre: pc + 2 <= cp 18.37 @@ -1091,7 +1093,8 @@ 18.38 put1(pc+1, od); 18.39 } 18.40 18.41 - /** Place four bytes into code at address pc. Pre: pc + 4 <= cp. 18.42 + /** Place four bytes into code at address pc. 18.43 + * Pre: {@literal pc + 4 <= cp }. 18.44 */ 18.45 public void put4(int pc, int od) { 18.46 // pre: pc + 4 <= cp 18.47 @@ -1990,7 +1993,7 @@ 18.48 nextreg = max_locals; 18.49 } 18.50 18.51 - /** End scopes of all variables with registers >= first. 18.52 + /** End scopes of all variables with registers ≥ first. 18.53 */ 18.54 public void endScopes(int first) { 18.55 int prevNextReg = nextreg;
19.1 --- a/src/share/classes/com/sun/tools/javac/jvm/Gen.java Sat Sep 08 22:54:21 2012 -0700 19.2 +++ b/src/share/classes/com/sun/tools/javac/jvm/Gen.java Thu Sep 13 14:29:36 2012 -0700 19.3 @@ -247,10 +247,10 @@ 19.4 /** Construct a symbol to reflect the qualifying type that should 19.5 * appear in the byte code as per JLS 13.1. 19.6 * 19.7 - * For target >= 1.2: Clone a method with the qualifier as owner (except 19.8 + * For {@literal target >= 1.2}: Clone a method with the qualifier as owner (except 19.9 * for those cases where we need to work around VM bugs). 19.10 * 19.11 - * For target <= 1.1: If qualified variable or method is defined in a 19.12 + * For {@literal target <= 1.1}: If qualified variable or method is defined in a 19.13 * non-accessible class, clone it with the qualifier class as owner. 19.14 * 19.15 * @param sym The accessed symbol
20.1 --- a/src/share/classes/com/sun/tools/javac/parser/JavacParser.java Sat Sep 08 22:54:21 2012 -0700 20.2 +++ b/src/share/classes/com/sun/tools/javac/parser/JavacParser.java Thu Sep 13 14:29:36 2012 -0700 20.3 @@ -670,6 +670,7 @@ 20.4 } 20.5 20.6 /** 20.7 + * {@literal 20.8 * Expression = Expression1 [ExpressionRest] 20.9 * ExpressionRest = [AssignmentOperator Expression1] 20.10 * AssignmentOperator = "=" | "+=" | "-=" | "*=" | "/=" | 20.11 @@ -679,6 +680,7 @@ 20.12 * TypeNoParams = TypeNoParams1 20.13 * StatementExpression = Expression 20.14 * ConstantExpression = Expression 20.15 + * } 20.16 */ 20.17 JCExpression term() { 20.18 JCExpression t = term1(); 20.19 @@ -884,9 +886,12 @@ 20.20 return opStack; 20.21 } 20.22 20.23 - /** Expression3 = PrefixOp Expression3 20.24 + /** 20.25 + * Expression3 = PrefixOp Expression3 20.26 * | "(" Expr | TypeNoParams ")" Expression3 20.27 * | Primary {Selector} {PostfixOp} 20.28 + * 20.29 + * {@literal 20.30 * Primary = "(" Expression ")" 20.31 * | Literal 20.32 * | [TypeArguments] THIS [Arguments] 20.33 @@ -901,6 +906,8 @@ 20.34 * | "." ( CLASS | THIS | [TypeArguments] SUPER Arguments | NEW [TypeArguments] InnerCreator ) 20.35 * ] 20.36 * | BasicType BracketsOpt "." CLASS 20.37 + * } 20.38 + * 20.39 * PrefixOp = "++" | "--" | "!" | "~" | "+" | "-" 20.40 * PostfixOp = "++" | "--" 20.41 * Type3 = Ident { "." Ident } [TypeArguments] {TypeSelector} BracketsOpt 20.42 @@ -1453,7 +1460,10 @@ 20.43 return null; 20.44 } 20.45 20.46 - /** TypeArguments = "<" TypeArgument {"," TypeArgument} ">" 20.47 + /** 20.48 + * {@literal 20.49 + * TypeArguments = "<" TypeArgument {"," TypeArgument} ">" 20.50 + * } 20.51 */ 20.52 List<JCExpression> typeArguments(boolean diamondAllowed) { 20.53 if (token.kind == LT) { 20.54 @@ -1490,10 +1500,13 @@ 20.55 } 20.56 } 20.57 20.58 - /** TypeArgument = Type 20.59 + /** 20.60 + * {@literal 20.61 + * TypeArgument = Type 20.62 * | "?" 20.63 * | "?" EXTENDS Type {"&" Type} 20.64 * | "?" SUPER Type 20.65 + * } 20.66 */ 20.67 JCExpression typeArgument() { 20.68 if (token.kind != QUES) return parseType(); 20.69 @@ -2991,7 +3004,10 @@ 20.70 return ts.toList(); 20.71 } 20.72 20.73 - /** TypeParametersOpt = ["<" TypeParameter {"," TypeParameter} ">"] 20.74 + /** 20.75 + * {@literal 20.76 + * TypeParametersOpt = ["<" TypeParameter {"," TypeParameter} ">"] 20.77 + * } 20.78 */ 20.79 List<JCTypeParameter> typeParametersOpt() { 20.80 if (token.kind == LT) { 20.81 @@ -3010,9 +3026,12 @@ 20.82 } 20.83 } 20.84 20.85 - /** TypeParameter = TypeVariable [TypeParameterBound] 20.86 + /** 20.87 + * {@literal 20.88 + * TypeParameter = TypeVariable [TypeParameterBound] 20.89 * TypeParameterBound = EXTENDS Type {"&" Type} 20.90 * TypeVariable = Ident 20.91 + * } 20.92 */ 20.93 JCTypeParameter typeParameter() { 20.94 int pos = token.pos;
21.1 --- a/src/share/classes/com/sun/tools/javac/parser/Lexer.java Sat Sep 08 22:54:21 2012 -0700 21.2 +++ b/src/share/classes/com/sun/tools/javac/parser/Lexer.java Thu Sep 13 14:29:36 2012 -0700 21.3 @@ -1,5 +1,5 @@ 21.4 /* 21.5 - * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved. 21.6 + * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. 21.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 21.8 * 21.9 * This code is free software; you can redistribute it and/or modify it 21.10 @@ -61,7 +61,8 @@ 21.11 21.12 /** 21.13 * Splits the current token in two and return the first (splitted) token. 21.14 - * For instance '<<<' is splitted into two tokens '<' and '<<' respectively, 21.15 + * For instance {@literal '<<<'} is split into two tokens 21.16 + * {@literal '<'} and {@literal '<<'} respectively, 21.17 * and the latter is returned. 21.18 */ 21.19 Token split();
22.1 --- a/src/share/classes/com/sun/tools/javac/processing/JavacProcessingEnvironment.java Sat Sep 08 22:54:21 2012 -0700 22.2 +++ b/src/share/classes/com/sun/tools/javac/processing/JavacProcessingEnvironment.java Thu Sep 13 14:29:36 2012 -0700 22.3 @@ -1364,7 +1364,8 @@ 22.4 * {@inheritdoc} 22.5 * 22.6 * Command line options suitable for presenting to annotation 22.7 - * processors. "-Afoo=bar" should be "-Afoo" => "bar". 22.8 + * processors. 22.9 + * {@literal "-Afoo=bar"} should be {@literal "-Afoo" => "bar"}. 22.10 */ 22.11 public Map<String,String> getOptions() { 22.12 return processorOptions;
23.1 --- a/src/share/classes/com/sun/tools/javac/tree/JCTree.java Sat Sep 08 22:54:21 2012 -0700 23.2 +++ b/src/share/classes/com/sun/tools/javac/tree/JCTree.java Thu Sep 13 14:29:36 2012 -0700 23.3 @@ -2010,7 +2010,7 @@ 23.4 } 23.5 23.6 /** 23.7 - * A parameterized type, T<...> 23.8 + * A parameterized type, {@literal T<...>} 23.9 */ 23.10 public static class JCTypeApply extends JCExpression implements ParameterizedTypeTree { 23.11 public JCExpression clazz;
24.1 --- a/src/share/classes/com/sun/tools/javac/tree/Pretty.java Sat Sep 08 22:54:21 2012 -0700 24.2 +++ b/src/share/classes/com/sun/tools/javac/tree/Pretty.java Thu Sep 13 14:29:36 2012 -0700 24.3 @@ -256,7 +256,8 @@ 24.4 return pos; 24.5 } 24.6 24.7 - /** If type parameter list is non-empty, print it enclosed in "<...>" brackets. 24.8 + /** If type parameter list is non-empty, print it enclosed in 24.9 + * {@literal "<...>"} brackets. 24.10 */ 24.11 public void printTypeParameters(List<JCTypeParameter> trees) throws IOException { 24.12 if (trees.nonEmpty()) {
25.1 --- a/src/share/classes/com/sun/tools/javac/util/Bits.java Sat Sep 08 22:54:21 2012 -0700 25.2 +++ b/src/share/classes/com/sun/tools/javac/util/Bits.java Thu Sep 13 14:29:36 2012 -0700 25.3 @@ -1,5 +1,5 @@ 25.4 /* 25.5 - * Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved. 25.6 + * Copyright (c) 1999, 2012, Oracle and/or its affiliates. All rights reserved. 25.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 25.8 * 25.9 * This code is free software; you can redistribute it and/or modify it 25.10 @@ -127,7 +127,7 @@ 25.11 (bits[x >>> wordshift] & (1 << (x & wordmask))) != 0; 25.12 } 25.13 25.14 - /** this set = this set & xs. 25.15 + /** {@literal this set = this set & xs}. 25.16 */ 25.17 public Bits andSet(Bits xs) { 25.18 sizeTo(xs.bits.length); 25.19 @@ -179,12 +179,12 @@ 25.20 return n - (x&1); 25.21 } 25.22 25.23 - /** Return the index of the least bit position >= x that is set. 25.24 + /** Return the index of the least bit position ≥ x that is set. 25.25 * If none are set, returns -1. This provides a nice way to iterate 25.26 * over the members of a bit set: 25.27 - * <pre> 25.28 + * <pre>{@code 25.29 * for (int i = bits.nextBit(0); i>=0; i = bits.nextBit(i+1)) ... 25.30 - * </pre> 25.31 + * }</pre> 25.32 */ 25.33 public int nextBit(int x) { 25.34 int windex = x >>> wordshift;
26.1 --- a/src/share/classes/com/sun/tools/javac/util/Context.java Sat Sep 08 22:54:21 2012 -0700 26.2 +++ b/src/share/classes/com/sun/tools/javac/util/Context.java Thu Sep 13 14:29:36 2012 -0700 26.3 @@ -1,5 +1,5 @@ 26.4 /* 26.5 - * Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved. 26.6 + * Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved. 26.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 26.8 * 26.9 * This code is free software; you can redistribute it and/or modify it 26.10 @@ -115,7 +115,10 @@ 26.11 * The underlying map storing the data. 26.12 * We maintain the invariant that this table contains only 26.13 * mappings of the form 26.14 - * Key<T> -> T or Key<T> -> Factory<T> */ 26.15 + * {@literal Key<T> -> T } 26.16 + * or 26.17 + * {@literal Key<T> -> Factory<T> } 26.18 + */ 26.19 private Map<Key<?>,Object> ht = new HashMap<Key<?>,Object>(); 26.20 26.21 /** Set the factory for the key in this context. */
27.1 --- a/src/share/classes/com/sun/tools/javac/util/Name.java Sat Sep 08 22:54:21 2012 -0700 27.2 +++ b/src/share/classes/com/sun/tools/javac/util/Name.java Thu Sep 13 14:29:36 2012 -0700 27.3 @@ -1,5 +1,5 @@ 27.4 /* 27.5 - * Copyright (c) 1999, 2008, Oracle and/or its affiliates. All rights reserved. 27.6 + * Copyright (c) 1999, 2012, Oracle and/or its affiliates. All rights reserved. 27.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 27.8 * 27.9 * This code is free software; you can redistribute it and/or modify it 27.10 @@ -43,28 +43,28 @@ 27.11 } 27.12 27.13 /** 27.14 - * @inheritDoc 27.15 + * {@inheritDoc} 27.16 */ 27.17 public boolean contentEquals(CharSequence cs) { 27.18 return toString().equals(cs.toString()); 27.19 } 27.20 27.21 /** 27.22 - * @inheritDoc 27.23 + * {@inheritDoc} 27.24 */ 27.25 public int length() { 27.26 return toString().length(); 27.27 } 27.28 27.29 /** 27.30 - * @inheritDoc 27.31 + * {@inheritDoc} 27.32 */ 27.33 public char charAt(int index) { 27.34 return toString().charAt(index); 27.35 } 27.36 27.37 /** 27.38 - * @inheritDoc 27.39 + * {@inheritDoc} 27.40 */ 27.41 public CharSequence subSequence(int start, int end) { 27.42 return toString().subSequence(start, end); 27.43 @@ -142,6 +142,7 @@ 27.44 27.45 /** Return the string representation of this name. 27.46 */ 27.47 + @Override 27.48 public String toString() { 27.49 return Convert.utf2string(getByteArray(), getByteOffset(), getByteLength()); 27.50 }
28.1 --- a/src/share/classes/com/sun/tools/javac/util/Position.java Sat Sep 08 22:54:21 2012 -0700 28.2 +++ b/src/share/classes/com/sun/tools/javac/util/Position.java Thu Sep 13 14:29:36 2012 -0700 28.3 @@ -1,5 +1,5 @@ 28.4 /* 28.5 - * Copyright (c) 1999, 2006, Oracle and/or its affiliates. All rights reserved. 28.6 + * Copyright (c) 1999, 2012, Oracle and/or its affiliates. All rights reserved. 28.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 28.8 * 28.9 * This code is free software; you can redistribute it and/or modify it 28.10 @@ -79,12 +79,12 @@ 28.11 } 28.12 28.13 /** Encode line and column numbers in an integer as: 28.14 - * line-number << LINESHIFT + column-number 28.15 - * {@link Position.NOPOS represents an undefined position. 28.16 + * {@code line-number << LINESHIFT + column-number }. 28.17 + * {@link Position.NOPOS} represents an undefined position. 28.18 * 28.19 * @param line number of line (first is 1) 28.20 * @param col number of character on line (first is 1) 28.21 - * @return an encoded position or {@link Position.NOPOS 28.22 + * @return an encoded position or {@link Position.NOPOS} 28.23 * if the line or column number is too big to 28.24 * represent in the encoded format 28.25 * @throws IllegalArgumentException if line or col is less than 1 28.26 @@ -107,8 +107,8 @@ 28.27 * @param line number of line (first is 1) 28.28 * @return position of first character in line 28.29 * @throws ArrayIndexOutOfBoundsException 28.30 - * if <tt>lineNumber < 1</tt> 28.31 - * if <tt>lineNumber > no. of lines</tt> 28.32 + * if {@code lineNumber < 1} 28.33 + * if {@code lineNumber > no. of lines} 28.34 */ 28.35 int getStartPosition(int line); 28.36 28.37 @@ -119,8 +119,8 @@ 28.38 * 28.39 * @return position of character 28.40 * @throws ArrayIndexOutOfBoundsException 28.41 - * if <tt>line < 1</tt> 28.42 - * if <tt>line > no. of lines</tt> 28.43 + * if {@code line < 1} 28.44 + * if {@code line > no. of lines} 28.45 */ 28.46 int getPosition(int line, int column); 28.47
29.1 --- a/src/share/classes/com/sun/tools/javadoc/Comment.java Sat Sep 08 22:54:21 2012 -0700 29.2 +++ b/src/share/classes/com/sun/tools/javadoc/Comment.java Thu Sep 13 14:29:36 2012 -0700 29.3 @@ -1,5 +1,5 @@ 29.4 /* 29.5 - * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. 29.6 + * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. 29.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 29.8 * 29.9 * This code is free software; you can redistribute it and/or modify it 29.10 @@ -386,7 +386,7 @@ 29.11 } 29.12 29.13 /** 29.14 - * Recursively search for the string "{@" followed by 29.15 + * Recursively search for the characters '{', '@', followed by 29.16 * name of inline tag and white space, 29.17 * if found 29.18 * return the index of the text following the white space.
30.1 --- a/src/share/classes/com/sun/tools/javadoc/DocImpl.java Sat Sep 08 22:54:21 2012 -0700 30.2 +++ b/src/share/classes/com/sun/tools/javadoc/DocImpl.java Thu Sep 13 14:29:36 2012 -0700 30.3 @@ -1,5 +1,5 @@ 30.4 /* 30.5 - * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. 30.6 + * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. 30.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 30.8 * 30.9 * This code is free software; you can redistribute it and/or modify it 30.10 @@ -138,7 +138,7 @@ 30.11 /** 30.12 * Return the see also tags in this Doc item. 30.13 * 30.14 - * @return an array of SeeTag containing all @see tags. 30.15 + * @return an array of SeeTag containing all @see tags. 30.16 */ 30.17 public SeeTag[] seeTags() { 30.18 return comment().seeTags();
31.1 --- a/src/share/classes/com/sun/tools/javadoc/FieldDocImpl.java Sat Sep 08 22:54:21 2012 -0700 31.2 +++ b/src/share/classes/com/sun/tools/javadoc/FieldDocImpl.java Thu Sep 13 14:29:36 2012 -0700 31.3 @@ -1,5 +1,5 @@ 31.4 /* 31.5 - * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. 31.6 + * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. 31.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 31.8 * 31.9 * This code is free software; you can redistribute it and/or modify it 31.10 @@ -241,7 +241,7 @@ 31.11 * Return the serialField tags in this FieldDocImpl item. 31.12 * 31.13 * @return an array of <tt>SerialFieldTagImpl</tt> containing all 31.14 - * <code>@serialField</code> tags. 31.15 + * <code>@serialField</code> tags. 31.16 */ 31.17 public SerialFieldTag[] serialFieldTags() { 31.18 return comment().serialFieldTags();
32.1 --- a/src/share/classes/com/sun/tools/javah/JavahTask.java Sat Sep 08 22:54:21 2012 -0700 32.2 +++ b/src/share/classes/com/sun/tools/javah/JavahTask.java Thu Sep 13 14:29:36 2012 -0700 32.3 @@ -79,7 +79,7 @@ 32.4 32.5 /** 32.6 * Javah generates support files for native methods. 32.7 - * Parse commandline options & Invokes javadoc to execute those commands. 32.8 + * Parse commandline options and invokes javadoc to execute those commands. 32.9 * 32.10 * <p><b>This is NOT part of any supported API. 32.11 * If you write code that depends on this, you do so at your own
33.1 --- a/src/share/classes/javax/lang/model/util/Elements.java Sat Sep 08 22:54:21 2012 -0700 33.2 +++ b/src/share/classes/javax/lang/model/util/Elements.java Thu Sep 13 14:29:36 2012 -0700 33.3 @@ -1,5 +1,5 @@ 33.4 /* 33.5 - * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved. 33.6 + * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. 33.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 33.8 * 33.9 * This code is free software; you can redistribute it and/or modify it 33.10 @@ -79,12 +79,12 @@ 33.11 * 33.12 * <p> A documentation comment of an element is a comment that 33.13 * begins with "{@code /**}" , ends with a separate 33.14 - * "<code>*/</code>", and immediately precedes the element, 33.15 + * "<code>*/</code>", and immediately precedes the element, 33.16 * ignoring white space. Therefore, a documentation comment 33.17 * contains at least three"{@code *}" characters. The text 33.18 * returned for the documentation comment is a processed form of 33.19 * the comment as it appears in source code. The leading "{@code 33.20 - * /**}" and trailing "<code>*/</code>" are removed. For lines 33.21 + * /**}" and trailing "<code>*/</code>" are removed. For lines 33.22 * of the comment starting after the initial "{@code /**}", 33.23 * leading white space characters are discarded as are any 33.24 * consecutive "{@code *}" characters appearing after the white
34.1 --- a/src/share/classes/javax/tools/JavaCompiler.java Sat Sep 08 22:54:21 2012 -0700 34.2 +++ b/src/share/classes/javax/tools/JavaCompiler.java Thu Sep 13 14:29:36 2012 -0700 34.3 @@ -1,5 +1,5 @@ 34.4 /* 34.5 - * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. 34.6 + * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. 34.7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 34.8 * 34.9 * This code is free software; you can redistribute it and/or modify it 34.10 @@ -137,7 +137,7 @@ 34.11 * StandardJavaFileManager fileManager = compiler.getStandardFileManager(diagnostics, null, null); 34.12 * compiler.getTask(null, fileManager, diagnostics, null, null, compilationUnits).call(); 34.13 * 34.14 - * for (Diagnostic<? extends JavaFileObject> diagnostic : diagnostics.getDiagnostics()) 34.15 + * for ({@code Diagnostic<? extends JavaFileObject>} diagnostic : diagnostics.getDiagnostics()) 34.16 * System.out.format("Error on line %d in %s%n", 34.17 * diagnostic.getLineNumber(), 34.18 * diagnostic.getSource().toUri());
