src/share/classes/com/sun/tools/javadoc/JavadocEnter.java

Fri, 05 Aug 2011 19:41:05 -0700

author
ksrini
date
Fri, 05 Aug 2011 19:41:05 -0700
changeset 1065
e9f118c2bd3c
parent 893
8f0dcb9499db
child 1280
5c0b3faeb0b0
permissions
-rw-r--r--

7064544: (javadoc) miscellaneous fixes requested by netbeans
Summary: Contributed by netbeans team, modified to suit by the langtools team.
Reviewed-by: jjg, bpatel

duke@1 1 /*
jjg@893 2 * Copyright (c) 2001, 2011, 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
duke@1 28 import com.sun.tools.javac.util.Context;
duke@1 29 import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;
duke@1 30 import com.sun.tools.javac.util.List;
duke@1 31 import com.sun.tools.javac.code.Kinds;
duke@1 32 import com.sun.tools.javac.code.Symbol.*;
duke@1 33 import com.sun.tools.javac.comp.Enter;
duke@1 34 import com.sun.tools.javac.tree.JCTree.*;
duke@1 35 import javax.tools.JavaFileObject;
duke@1 36
duke@1 37 /**
duke@1 38 * Javadoc's own enter phase does a few things above and beyond that
duke@1 39 * done by javac.
duke@1 40 * @author Neal Gafter
duke@1 41 */
duke@1 42 public class JavadocEnter extends Enter {
duke@1 43 public static JavadocEnter instance0(Context context) {
duke@1 44 Enter instance = context.get(enterKey);
duke@1 45 if (instance == null)
duke@1 46 instance = new JavadocEnter(context);
duke@1 47 return (JavadocEnter)instance;
duke@1 48 }
duke@1 49
jjg@893 50 public static void preRegister(Context context) {
duke@1 51 context.put(enterKey, new Context.Factory<Enter>() {
jjg@893 52 public Enter make(Context c) {
jjg@893 53 return new JavadocEnter(c);
duke@1 54 }
duke@1 55 });
duke@1 56 }
duke@1 57
duke@1 58 protected JavadocEnter(Context context) {
duke@1 59 super(context);
duke@1 60 messager = Messager.instance0(context);
duke@1 61 docenv = DocEnv.instance(context);
duke@1 62 }
duke@1 63
duke@1 64 final Messager messager;
duke@1 65 final DocEnv docenv;
duke@1 66
ksrini@1065 67 @Override
duke@1 68 public void main(List<JCCompilationUnit> trees) {
duke@1 69 // count all Enter errors as warnings.
duke@1 70 int nerrors = messager.nerrors;
duke@1 71 super.main(trees);
duke@1 72 messager.nwarnings += (messager.nerrors - nerrors);
duke@1 73 messager.nerrors = nerrors;
duke@1 74 }
duke@1 75
ksrini@1065 76 @Override
duke@1 77 public void visitTopLevel(JCCompilationUnit tree) {
duke@1 78 super.visitTopLevel(tree);
duke@1 79 if (tree.sourcefile.isNameCompatible("package-info", JavaFileObject.Kind.SOURCE)) {
duke@1 80 String comment = tree.docComments.get(tree);
duke@1 81 docenv.makePackageDoc(tree.packge, comment, tree);
duke@1 82 }
duke@1 83 }
duke@1 84
ksrini@1065 85 @Override
duke@1 86 public void visitClassDef(JCClassDecl tree) {
duke@1 87 super.visitClassDef(tree);
ksrini@1065 88 if (tree.sym == null) return;
ksrini@1065 89 if (tree.sym.kind == Kinds.TYP || tree.sym.kind == Kinds.ERR) {
duke@1 90 String comment = env.toplevel.docComments.get(tree);
jjg@74 91 ClassSymbol c = tree.sym;
duke@1 92 docenv.makeClassDoc(c, comment, tree, env.toplevel.lineMap);
duke@1 93 }
duke@1 94 }
duke@1 95
duke@1 96 /** Don't complain about a duplicate class. */
ksrini@1065 97 @Override
duke@1 98 protected void duplicateClass(DiagnosticPosition pos, ClassSymbol c) {}
duke@1 99
duke@1 100 }

mercurial