duke@1: /*
jjg@1359:  * Copyright (c) 1997, 2012, 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.javadoc.*;
duke@1: 
jjg@1443: import com.sun.source.util.TreePath;
duke@1: import com.sun.tools.javac.code.Symbol;
duke@1: 
duke@1: /**
duke@1:  * Represents a member of a java class: field, constructor, or method.
duke@1:  * This is an abstract class dealing with information common to
duke@1:  * method, constructor and field members. Class members of a class
duke@1:  * (nested classes) are represented instead by ClassDocImpl.
duke@1:  *
jjg@1359:  *  <p><b>This is NOT part of any supported API.
jjg@1359:  *  If you write code that depends on this, you do so at your own risk.
jjg@1359:  *  This code and its internal interfaces are subject to change or
jjg@1359:  *  deletion without notice.</b>
jjg@1359:  *
duke@1:  * @see MethodDocImpl
duke@1:  * @see FieldDocImpl
duke@1:  * @see ClassDocImpl
duke@1:  *
duke@1:  * @author Robert Field
duke@1:  * @author Neal Gafter
duke@1:  */
duke@1: 
duke@1: public abstract class MemberDocImpl
duke@1:     extends ProgramElementDocImpl
duke@1:     implements MemberDoc {
duke@1: 
duke@1:     /**
duke@1:      * constructor.
duke@1:      */
jjg@1443:     public MemberDocImpl(DocEnv env, Symbol sym, TreePath treePath) {
jjg@1443:         super(env, sym, treePath);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Returns true if this field was synthesized by the compiler.
duke@1:      */
duke@1:     public abstract boolean isSynthetic();
duke@1: }