Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javadoc/JavadocEnter.java@78962d89f283 (annotated)
src/share/classes/com/sun/tools/javadoc/JavadocEnter.java
Tue, 23 Oct 2012 13:20:37 -0700
- author
- jjg
- date
- Tue, 23 Oct 2012 13:20:37 -0700
- changeset 1372
- 78962d89f283
- parent 1359
- 25e14ad23cef
- child 1443
- cfde9737131e
- permissions
- -rw-r--r--
8000741: refactor javadoc to use abstraction to handle relative paths
Reviewed-by: darcy
| duke@1 | 1 | /* |
| jjg@1280 | 2 | * Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.tools.javadoc; |
| duke@1 | 27 | |
| jjg@1280 | 28 | import javax.tools.JavaFileObject; |
| jjg@1280 | 29 | |
| duke@1 | 30 | import com.sun.tools.javac.code.Kinds; |
| duke@1 | 31 | import com.sun.tools.javac.code.Symbol.*; |
| duke@1 | 32 | import com.sun.tools.javac.comp.Enter; |
| duke@1 | 33 | import com.sun.tools.javac.tree.JCTree.*; |
| jjg@1280 | 34 | import com.sun.tools.javac.tree.TreeInfo; |
| jjg@1280 | 35 | import com.sun.tools.javac.util.Context; |
| jjg@1280 | 36 | import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition; |
| jjg@1280 | 37 | import com.sun.tools.javac.util.List; |
| duke@1 | 38 | |
| duke@1 | 39 | /** |
| duke@1 | 40 | * Javadoc's own enter phase does a few things above and beyond that |
| duke@1 | 41 | * done by javac. |
| jjg@1359 | 42 | * |
| jjg@1359 | 43 | * <p><b>This is NOT part of any supported API. |
| jjg@1359 | 44 | * If you write code that depends on this, you do so at your own risk. |
| jjg@1359 | 45 | * This code and its internal interfaces are subject to change or |
| jjg@1359 | 46 | * deletion without notice.</b> |
| jjg@1359 | 47 | * |
| duke@1 | 48 | * @author Neal Gafter |
| duke@1 | 49 | */ |
| duke@1 | 50 | public class JavadocEnter extends Enter { |
| duke@1 | 51 | public static JavadocEnter instance0(Context context) { |
| duke@1 | 52 | Enter instance = context.get(enterKey); |
| duke@1 | 53 | if (instance == null) |
| duke@1 | 54 | instance = new JavadocEnter(context); |
| duke@1 | 55 | return (JavadocEnter)instance; |
| duke@1 | 56 | } |
| duke@1 | 57 | |
| jjg@893 | 58 | public static void preRegister(Context context) { |
| duke@1 | 59 | context.put(enterKey, new Context.Factory<Enter>() { |
| jjg@893 | 60 | public Enter make(Context c) { |
| jjg@893 | 61 | return new JavadocEnter(c); |
| duke@1 | 62 | } |
| duke@1 | 63 | }); |
| duke@1 | 64 | } |
| duke@1 | 65 | |
| duke@1 | 66 | protected JavadocEnter(Context context) { |
| duke@1 | 67 | super(context); |
| duke@1 | 68 | messager = Messager.instance0(context); |
| duke@1 | 69 | docenv = DocEnv.instance(context); |
| duke@1 | 70 | } |
| duke@1 | 71 | |
| duke@1 | 72 | final Messager messager; |
| duke@1 | 73 | final DocEnv docenv; |
| duke@1 | 74 | |
| ksrini@1065 | 75 | @Override |
| duke@1 | 76 | public void main(List<JCCompilationUnit> trees) { |
| duke@1 | 77 | // count all Enter errors as warnings. |
| duke@1 | 78 | int nerrors = messager.nerrors; |
| duke@1 | 79 | super.main(trees); |
| duke@1 | 80 | messager.nwarnings += (messager.nerrors - nerrors); |
| duke@1 | 81 | messager.nerrors = nerrors; |
| duke@1 | 82 | } |
| duke@1 | 83 | |
| ksrini@1065 | 84 | @Override |
| duke@1 | 85 | public void visitTopLevel(JCCompilationUnit tree) { |
| duke@1 | 86 | super.visitTopLevel(tree); |
| duke@1 | 87 | if (tree.sourcefile.isNameCompatible("package-info", JavaFileObject.Kind.SOURCE)) { |
| jjg@1280 | 88 | String comment = TreeInfo.getCommentText(env, tree); |
| duke@1 | 89 | docenv.makePackageDoc(tree.packge, comment, tree); |
| duke@1 | 90 | } |
| duke@1 | 91 | } |
| duke@1 | 92 | |
| ksrini@1065 | 93 | @Override |
| duke@1 | 94 | public void visitClassDef(JCClassDecl tree) { |
| duke@1 | 95 | super.visitClassDef(tree); |
| ksrini@1065 | 96 | if (tree.sym == null) return; |
| ksrini@1065 | 97 | if (tree.sym.kind == Kinds.TYP || tree.sym.kind == Kinds.ERR) { |
| jjg@1280 | 98 | String comment = TreeInfo.getCommentText(env, tree); |
| jjg@74 | 99 | ClassSymbol c = tree.sym; |
| duke@1 | 100 | docenv.makeClassDoc(c, comment, tree, env.toplevel.lineMap); |
| duke@1 | 101 | } |
| duke@1 | 102 | } |
| duke@1 | 103 | |
| duke@1 | 104 | /** Don't complain about a duplicate class. */ |
| ksrini@1065 | 105 | @Override |
| duke@1 | 106 | protected void duplicateClass(DiagnosticPosition pos, ClassSymbol c) {} |
| duke@1 | 107 | |
| duke@1 | 108 | } |
