/*
* Copyright 2008-2009 Sun Microsystems, Inc. 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.
*
* 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
* CA 95054 USA or visit www.sun.com if you need additional information or
* have any questions.
*/
package org.visage.tools.visagedoc;
import com.sun.javadoc.*;
import com.sun.tools.mjavac.code.Symbol;
import org.visage.tools.tree.VisageTree;
import com.sun.tools.mjavac.util.Position;
/**
* Represents a member of a java class: field, constructor, or method.
* This is an abstract class dealing with information common to
* method, constructor and field members. Class members of a class
* (nested classes) are represented instead by ClassDocImpl.
*
* @see MethodDocImpl
* @see FieldDocImpl
* @see ClassDocImpl
*
* @author Robert Field
* @author Neal Gafter
*/
public abstract class MemberDocImpl
extends ProgramElementDocImpl
implements MemberDoc {
/**
* constructor.
*/
public MemberDocImpl(DocEnv env, Symbol sym, String doc, VisageTree tree, Position.LineMap lineMap) {
super(env, sym, doc, tree, lineMap);
}
/**
* Returns true if this field was synthesized by the compiler.
*/
public abstract boolean isSynthetic();
}