duke@1: /*
ohair@554:  * Copyright (c) 2003, 2008, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.javadoc;
duke@1: 
duke@1: import com.sun.tools.javac.util.Context;
duke@1: import com.sun.tools.javac.util.Position;
duke@1: import com.sun.tools.javac.code.Flags;
duke@1: import com.sun.tools.javac.code.Kinds;
duke@1: import com.sun.tools.javac.code.Symbol.*;
duke@1: import com.sun.tools.javac.comp.MemberEnter;
duke@1: import com.sun.tools.javac.tree.JCTree.*;
duke@1: 
duke@1: /**
duke@1:  *  Javadoc's own memberEnter phase does a few things above and beyond that
duke@1:  *  done by javac.
duke@1:  *  @author Neal Gafter
duke@1:  */
duke@1: class JavadocMemberEnter extends MemberEnter {
duke@1:     public static JavadocMemberEnter instance0(Context context) {
duke@1:         MemberEnter instance = context.get(memberEnterKey);
duke@1:         if (instance == null)
duke@1:             instance = new JavadocMemberEnter(context);
duke@1:         return (JavadocMemberEnter)instance;
duke@1:     }
duke@1: 
duke@1:     public static void preRegister(final Context context) {
duke@1:         context.put(memberEnterKey, new Context.Factory<MemberEnter>() {
duke@1:                public MemberEnter make() {
duke@1:                    return new JavadocMemberEnter(context);
duke@1:                }
duke@1:         });
duke@1:     }
duke@1: 
duke@1:     final DocEnv docenv;
duke@1: 
duke@1:     protected JavadocMemberEnter(Context context) {
duke@1:         super(context);
duke@1:         docenv = DocEnv.instance(context);
duke@1:     }
duke@1: 
duke@1:     public void visitMethodDef(JCMethodDecl tree) {
duke@1:         super.visitMethodDef(tree);
jjg@74:         MethodSymbol meth = tree.sym;
duke@1:         if (meth == null || meth.kind != Kinds.MTH) return;
duke@1:         String docComment = env.toplevel.docComments.get(tree);
duke@1:         Position.LineMap lineMap = env.toplevel.lineMap;
duke@1:         if (meth.isConstructor())
duke@1:             docenv.makeConstructorDoc(meth, docComment, tree, lineMap);
duke@1:         else if (isAnnotationTypeElement(meth))
duke@1:             docenv.makeAnnotationTypeElementDoc(meth, docComment, tree, lineMap);
duke@1:         else
duke@1:             docenv.makeMethodDoc(meth, docComment, tree, lineMap);
duke@1:     }
duke@1: 
duke@1:     public void visitVarDef(JCVariableDecl tree) {
duke@1:         super.visitVarDef(tree);
duke@1:         if (tree.sym != null &&
duke@1:                 tree.sym.kind == Kinds.VAR &&
duke@1:                 !isParameter(tree.sym)) {
duke@1:             String docComment = env.toplevel.docComments.get(tree);
duke@1:             Position.LineMap lineMap = env.toplevel.lineMap;
jjg@74:             docenv.makeFieldDoc(tree.sym, docComment, tree, lineMap);
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     private static boolean isAnnotationTypeElement(MethodSymbol meth) {
duke@1:         return ClassDocImpl.isAnnotationType(meth.enclClass());
duke@1:     }
duke@1: 
duke@1:     private static boolean isParameter(VarSymbol var) {
duke@1:         return (var.flags() & Flags.PARAMETER) != 0;
duke@1:     }
duke@1: }