langtools/src/share/classes/com/sun/tools/javadoc/JavadocMemberEnter.java
author jjg
Tue, 11 Dec 2012 15:05:55 -0800
changeset 14802 969e90f68ac5
parent 14441 6c066a762e05
child 15354 52a04c670c05
permissions -rw-r--r--
8004828: refactor init of *DocImpl classes Reviewed-by: darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
13077
16fb753bb5dc 7174143: encapsulate doc comment table
jjg
parents: 10189
diff changeset
     2
 * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    20
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
    23
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
package com.sun.tools.javadoc;
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
14802
969e90f68ac5 8004828: refactor init of *DocImpl classes
jjg
parents: 14441
diff changeset
    28
import com.sun.source.util.TreePath;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
import com.sun.tools.javac.code.Flags;
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
import com.sun.tools.javac.code.Kinds;
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
import com.sun.tools.javac.code.Symbol.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
import com.sun.tools.javac.comp.MemberEnter;
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
import com.sun.tools.javac.tree.JCTree.*;
13077
16fb753bb5dc 7174143: encapsulate doc comment table
jjg
parents: 10189
diff changeset
    34
import com.sun.tools.javac.util.Context;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
 *  Javadoc's own memberEnter phase does a few things above and beyond that
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
 *  done by javac.
14260
727a84636f12 8000665: fix "internal API" comments on javadoc files
jjg
parents: 13077
diff changeset
    39
 *
727a84636f12 8000665: fix "internal API" comments on javadoc files
jjg
parents: 13077
diff changeset
    40
 *  <p><b>This is NOT part of any supported API.
727a84636f12 8000665: fix "internal API" comments on javadoc files
jjg
parents: 13077
diff changeset
    41
 *  If you write code that depends on this, you do so at your own risk.
727a84636f12 8000665: fix "internal API" comments on javadoc files
jjg
parents: 13077
diff changeset
    42
 *  This code and its internal interfaces are subject to change or
727a84636f12 8000665: fix "internal API" comments on javadoc files
jjg
parents: 13077
diff changeset
    43
 *  deletion without notice.</b>
727a84636f12 8000665: fix "internal API" comments on javadoc files
jjg
parents: 13077
diff changeset
    44
 *
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
 *  @author Neal Gafter
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
 */
10189
57268b86d4da 7059905: (javadoc) promote method visibility for netbeans usage
ksrini
parents: 8614
diff changeset
    47
public class JavadocMemberEnter extends MemberEnter {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
    public static JavadocMemberEnter instance0(Context context) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
        MemberEnter instance = context.get(memberEnterKey);
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
        if (instance == null)
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
            instance = new JavadocMemberEnter(context);
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
        return (JavadocMemberEnter)instance;
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
8614
06e42328ddab 7021650: fix Context issues
jjg
parents: 5520
diff changeset
    55
    public static void preRegister(Context context) {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
        context.put(memberEnterKey, new Context.Factory<MemberEnter>() {
8614
06e42328ddab 7021650: fix Context issues
jjg
parents: 5520
diff changeset
    57
               public MemberEnter make(Context c) {
06e42328ddab 7021650: fix Context issues
jjg
parents: 5520
diff changeset
    58
                   return new JavadocMemberEnter(c);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
               }
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
        });
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
    final DocEnv docenv;
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
    protected JavadocMemberEnter(Context context) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
        super(context);
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
        docenv = DocEnv.instance(context);
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
13077
16fb753bb5dc 7174143: encapsulate doc comment table
jjg
parents: 10189
diff changeset
    70
    @Override
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
    public void visitMethodDef(JCMethodDecl tree) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
        super.visitMethodDef(tree);
868
d0f233085cbb 6657907: javadoc has unchecked warnings
jjg
parents: 10
diff changeset
    73
        MethodSymbol meth = tree.sym;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
        if (meth == null || meth.kind != Kinds.MTH) return;
14802
969e90f68ac5 8004828: refactor init of *DocImpl classes
jjg
parents: 14441
diff changeset
    75
        TreePath treePath = docenv.getTreePath(env.toplevel, tree);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
        if (meth.isConstructor())
14802
969e90f68ac5 8004828: refactor init of *DocImpl classes
jjg
parents: 14441
diff changeset
    77
            docenv.makeConstructorDoc(meth, treePath);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
        else if (isAnnotationTypeElement(meth))
14802
969e90f68ac5 8004828: refactor init of *DocImpl classes
jjg
parents: 14441
diff changeset
    79
            docenv.makeAnnotationTypeElementDoc(meth, treePath);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
        else
14802
969e90f68ac5 8004828: refactor init of *DocImpl classes
jjg
parents: 14441
diff changeset
    81
            docenv.makeMethodDoc(meth, treePath);
14441
6c066a762e05 8002146: javadoc doesn't release resources in a timely manner
jjg
parents: 14260
diff changeset
    82
6c066a762e05 8002146: javadoc doesn't release resources in a timely manner
jjg
parents: 14260
diff changeset
    83
        // release resources
6c066a762e05 8002146: javadoc doesn't release resources in a timely manner
jjg
parents: 14260
diff changeset
    84
        tree.body = null;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
13077
16fb753bb5dc 7174143: encapsulate doc comment table
jjg
parents: 10189
diff changeset
    87
    @Override
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
    public void visitVarDef(JCVariableDecl tree) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
        super.visitVarDef(tree);
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
        if (tree.sym != null &&
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
                tree.sym.kind == Kinds.VAR &&
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
                !isParameter(tree.sym)) {
14802
969e90f68ac5 8004828: refactor init of *DocImpl classes
jjg
parents: 14441
diff changeset
    93
            docenv.makeFieldDoc(tree.sym, docenv.getTreePath(env.toplevel, tree));
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
    private static boolean isAnnotationTypeElement(MethodSymbol meth) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
        return ClassDocImpl.isAnnotationType(meth.enclClass());
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
    private static boolean isParameter(VarSymbol var) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
        return (var.flags() & Flags.PARAMETER) != 0;
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
}