23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee/*
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved.
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee *
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * This code is free software; you can redistribute it and/or modify it
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * under the terms of the GNU General Public License version 2 only, as
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * published by the Free Software Foundation. Oracle designates this
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * particular file as subject to the "Classpath" exception as provided
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * by Oracle in the LICENSE file that accompanied this code.
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee *
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * This code is distributed in the hope that it will be useful, but WITHOUT
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * version 2 for more details (a copy is included in the LICENSE file that
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * accompanied this code).
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee *
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * You should have received a copy of the GNU General Public License version
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * 2 along with this work; if not, write to the Free Software Foundation,
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee *
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * or visit www.oracle.com if you need additional information or have any
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * questions.
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee */
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomeepackage com.sun.tools.javadoc;
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomeeimport com.sun.tools.javac.util.Context;
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomeeimport com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomeeimport com.sun.tools.javac.util.List;
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomeeimport com.sun.tools.javac.code.Kinds;
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomeeimport com.sun.tools.javac.code.Symbol.*;
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomeeimport com.sun.tools.javac.comp.Enter;
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomeeimport com.sun.tools.javac.tree.JCTree.*;
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomeeimport javax.tools.JavaFileObject;
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee/**
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * Javadoc's own enter phase does a few things above and beyond that
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * done by javac.
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee * @author Neal Gafter
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee */
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomeepublic class JavadocEnter extends Enter {
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee public static JavadocEnter instance0(Context context) {
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee Enter instance = context.get(enterKey);
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee if (instance == null)
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee instance = new JavadocEnter(context);
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee return (JavadocEnter)instance;
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee }
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee public static void preRegister(Context context) {
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee context.put(enterKey, new Context.Factory<Enter>() {
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee public Enter make(Context c) {
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee return new JavadocEnter(c);
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee }
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee });
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee }
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee protected JavadocEnter(Context context) {
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee super(context);
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee messager = Messager.instance0(context);
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee docenv = DocEnv.instance(context);
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee }
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee final Messager messager;
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee final DocEnv docenv;
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee @Override
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee public void main(List<JCCompilationUnit> trees) {
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee // count all Enter errors as warnings.
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee int nerrors = messager.nerrors;
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee super.main(trees);
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee messager.nwarnings += (messager.nerrors - nerrors);
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee messager.nerrors = nerrors;
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee }
23b5c241225a8ade2b6b9f06ebb891ee459e3b02tomee
@Override
public void visitTopLevel(JCCompilationUnit tree) {
super.visitTopLevel(tree);
if (tree.sourcefile.isNameCompatible("package-info", JavaFileObject.Kind.SOURCE)) {
String comment = tree.docComments.get(tree);
docenv.makePackageDoc(tree.packge, comment, tree);
}
}
@Override
public void visitClassDef(JCClassDecl tree) {
super.visitClassDef(tree);
if (tree.sym == null) return;
if (tree.sym.kind == Kinds.TYP || tree.sym.kind == Kinds.ERR) {
String comment = env.toplevel.docComments.get(tree);
ClassSymbol c = tree.sym;
docenv.makeClassDoc(c, comment, tree, env.toplevel.lineMap);
}
}
/** Don't complain about a duplicate class. */
@Override
protected void duplicateClass(DiagnosticPosition pos, ClassSymbol c) {}
}