Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javadoc/JavadocMemberEnter.java@5c0b3faeb0b0 (annotated)
src/share/classes/com/sun/tools/javadoc/JavadocMemberEnter.java
Wed, 20 Jun 2012 13:23:26 -0700
- author
- jjg
- date
- Wed, 20 Jun 2012 13:23:26 -0700
- changeset 1280
- 5c0b3faeb0b0
- parent 1051
- b0909f992710
- child 1359
- 25e14ad23cef
- permissions
- -rw-r--r--
7174143: encapsulate doc comment table
Reviewed-by: ksrini, mcimadamore
| duke@1 | 1 | /* |
| jjg@1280 | 2 | * Copyright (c) 2003, 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 | |
| duke@1 | 28 | import com.sun.tools.javac.code.Flags; |
| duke@1 | 29 | import com.sun.tools.javac.code.Kinds; |
| duke@1 | 30 | import com.sun.tools.javac.code.Symbol.*; |
| duke@1 | 31 | import com.sun.tools.javac.comp.MemberEnter; |
| duke@1 | 32 | import com.sun.tools.javac.tree.JCTree.*; |
| jjg@1280 | 33 | import com.sun.tools.javac.tree.TreeInfo; |
| jjg@1280 | 34 | import com.sun.tools.javac.util.Context; |
| jjg@1280 | 35 | import com.sun.tools.javac.util.Position; |
| duke@1 | 36 | |
| duke@1 | 37 | /** |
| duke@1 | 38 | * Javadoc's own memberEnter phase does a few things above and beyond that |
| duke@1 | 39 | * done by javac. |
| duke@1 | 40 | * @author Neal Gafter |
| duke@1 | 41 | */ |
| ksrini@1051 | 42 | public class JavadocMemberEnter extends MemberEnter { |
| duke@1 | 43 | public static JavadocMemberEnter instance0(Context context) { |
| duke@1 | 44 | MemberEnter instance = context.get(memberEnterKey); |
| duke@1 | 45 | if (instance == null) |
| duke@1 | 46 | instance = new JavadocMemberEnter(context); |
| duke@1 | 47 | return (JavadocMemberEnter)instance; |
| duke@1 | 48 | } |
| duke@1 | 49 | |
| jjg@893 | 50 | public static void preRegister(Context context) { |
| duke@1 | 51 | context.put(memberEnterKey, new Context.Factory<MemberEnter>() { |
| jjg@893 | 52 | public MemberEnter make(Context c) { |
| jjg@893 | 53 | return new JavadocMemberEnter(c); |
| duke@1 | 54 | } |
| duke@1 | 55 | }); |
| duke@1 | 56 | } |
| duke@1 | 57 | |
| duke@1 | 58 | final DocEnv docenv; |
| duke@1 | 59 | |
| duke@1 | 60 | protected JavadocMemberEnter(Context context) { |
| duke@1 | 61 | super(context); |
| duke@1 | 62 | docenv = DocEnv.instance(context); |
| duke@1 | 63 | } |
| duke@1 | 64 | |
| jjg@1280 | 65 | @Override |
| duke@1 | 66 | public void visitMethodDef(JCMethodDecl tree) { |
| duke@1 | 67 | super.visitMethodDef(tree); |
| jjg@74 | 68 | MethodSymbol meth = tree.sym; |
| duke@1 | 69 | if (meth == null || meth.kind != Kinds.MTH) return; |
| jjg@1280 | 70 | String docComment = TreeInfo.getCommentText(env, tree); |
| duke@1 | 71 | Position.LineMap lineMap = env.toplevel.lineMap; |
| duke@1 | 72 | if (meth.isConstructor()) |
| duke@1 | 73 | docenv.makeConstructorDoc(meth, docComment, tree, lineMap); |
| duke@1 | 74 | else if (isAnnotationTypeElement(meth)) |
| duke@1 | 75 | docenv.makeAnnotationTypeElementDoc(meth, docComment, tree, lineMap); |
| duke@1 | 76 | else |
| duke@1 | 77 | docenv.makeMethodDoc(meth, docComment, tree, lineMap); |
| duke@1 | 78 | } |
| duke@1 | 79 | |
| jjg@1280 | 80 | @Override |
| duke@1 | 81 | public void visitVarDef(JCVariableDecl tree) { |
| duke@1 | 82 | super.visitVarDef(tree); |
| duke@1 | 83 | if (tree.sym != null && |
| duke@1 | 84 | tree.sym.kind == Kinds.VAR && |
| duke@1 | 85 | !isParameter(tree.sym)) { |
| jjg@1280 | 86 | String docComment = TreeInfo.getCommentText(env, tree); |
| duke@1 | 87 | Position.LineMap lineMap = env.toplevel.lineMap; |
| jjg@74 | 88 | docenv.makeFieldDoc(tree.sym, docComment, tree, lineMap); |
| duke@1 | 89 | } |
| duke@1 | 90 | } |
| duke@1 | 91 | |
| duke@1 | 92 | private static boolean isAnnotationTypeElement(MethodSymbol meth) { |
| duke@1 | 93 | return ClassDocImpl.isAnnotationType(meth.enclClass()); |
| duke@1 | 94 | } |
| duke@1 | 95 | |
| duke@1 | 96 | private static boolean isParameter(VarSymbol var) { |
| duke@1 | 97 | return (var.flags() & Flags.PARAMETER) != 0; |
| duke@1 | 98 | } |
| duke@1 | 99 | } |
