mirror of
https://github.com/openjdk/jdk.git
synced 2025-09-21 03:24:38 +02:00
104 lines
3.7 KiB
Java
104 lines
3.7 KiB
Java
/*
|
|
* Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* This code is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License version 2 only, as
|
|
* published by the Free Software Foundation. Oracle designates this
|
|
* particular file as subject to the "Classpath" exception as provided
|
|
* by Oracle in the LICENSE file that accompanied this code.
|
|
*
|
|
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
* version 2 for more details (a copy is included in the LICENSE file that
|
|
* accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU General Public License version
|
|
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
* or visit www.oracle.com if you need additional information or have any
|
|
* questions.
|
|
*/
|
|
|
|
package com.sun.tools.javadoc;
|
|
|
|
import com.sun.source.util.TreePath;
|
|
import com.sun.tools.javac.code.Flags;
|
|
import com.sun.tools.javac.code.Kinds;
|
|
import com.sun.tools.javac.code.Symbol.*;
|
|
import com.sun.tools.javac.comp.MemberEnter;
|
|
import com.sun.tools.javac.tree.JCTree.*;
|
|
import com.sun.tools.javac.util.Context;
|
|
|
|
/**
|
|
* Javadoc's own memberEnter phase does a few things above and beyond that
|
|
* done by javac.
|
|
*
|
|
* <p><b>This is NOT part of any supported API.
|
|
* If you write code that depends on this, you do so at your own risk.
|
|
* This code and its internal interfaces are subject to change or
|
|
* deletion without notice.</b>
|
|
*
|
|
* @author Neal Gafter
|
|
*/
|
|
public class JavadocMemberEnter extends MemberEnter {
|
|
public static JavadocMemberEnter instance0(Context context) {
|
|
MemberEnter instance = context.get(memberEnterKey);
|
|
if (instance == null)
|
|
instance = new JavadocMemberEnter(context);
|
|
return (JavadocMemberEnter)instance;
|
|
}
|
|
|
|
public static void preRegister(Context context) {
|
|
context.put(memberEnterKey, new Context.Factory<MemberEnter>() {
|
|
public MemberEnter make(Context c) {
|
|
return new JavadocMemberEnter(c);
|
|
}
|
|
});
|
|
}
|
|
|
|
final DocEnv docenv;
|
|
|
|
protected JavadocMemberEnter(Context context) {
|
|
super(context);
|
|
docenv = DocEnv.instance(context);
|
|
}
|
|
|
|
@Override
|
|
public void visitMethodDef(JCMethodDecl tree) {
|
|
super.visitMethodDef(tree);
|
|
MethodSymbol meth = tree.sym;
|
|
if (meth == null || meth.kind != Kinds.MTH) return;
|
|
TreePath treePath = docenv.getTreePath(env.toplevel, tree);
|
|
if (meth.isConstructor())
|
|
docenv.makeConstructorDoc(meth, treePath);
|
|
else if (isAnnotationTypeElement(meth))
|
|
docenv.makeAnnotationTypeElementDoc(meth, treePath);
|
|
else
|
|
docenv.makeMethodDoc(meth, treePath);
|
|
|
|
// release resources
|
|
tree.body = null;
|
|
}
|
|
|
|
@Override
|
|
public void visitVarDef(JCVariableDecl tree) {
|
|
super.visitVarDef(tree);
|
|
if (tree.sym != null &&
|
|
tree.sym.kind == Kinds.VAR &&
|
|
!isParameter(tree.sym)) {
|
|
docenv.makeFieldDoc(tree.sym, docenv.getTreePath(env.toplevel, tree));
|
|
}
|
|
}
|
|
|
|
private static boolean isAnnotationTypeElement(MethodSymbol meth) {
|
|
return ClassDocImpl.isAnnotationType(meth.enclClass());
|
|
}
|
|
|
|
private static boolean isParameter(VarSymbol var) {
|
|
return (var.flags() & Flags.PARAMETER) != 0;
|
|
}
|
|
}
|