1/* 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26package com.sun.tools.javadoc.main; 27 28import com.sun.javadoc.*; 29 30import com.sun.source.util.TreePath; 31import com.sun.tools.javac.code.Symbol; 32 33/** 34 * Represents a member of a java class: field, constructor, or method. 35 * This is an abstract class dealing with information common to 36 * method, constructor and field members. Class members of a class 37 * (nested classes) are represented instead by ClassDocImpl. 38 * 39 * <p><b>This is NOT part of any supported API. 40 * If you write code that depends on this, you do so at your own risk. 41 * This code and its internal interfaces are subject to change or 42 * deletion without notice.</b> 43 * 44 * @see MethodDocImpl 45 * @see FieldDocImpl 46 * @see ClassDocImpl 47 * 48 * @author Robert Field 49 * @author Neal Gafter 50 */ 51 52@Deprecated 53public abstract class MemberDocImpl 54 extends ProgramElementDocImpl 55 implements MemberDoc { 56 57 /** 58 * constructor. 59 */ 60 public MemberDocImpl(DocEnv env, Symbol sym, TreePath treePath) { 61 super(env, sym, treePath); 62 } 63 64 /** 65 * Returns true if this field was synthesized by the compiler. 66 */ 67 public abstract boolean isSynthetic(); 68} 69