src/share/classes/com/sun/tools/javadoc/MemberDocImpl.java

Mon, 25 Mar 2013 16:55:14 -0700

author
mfang
date
Mon, 25 Mar 2013 16:55:14 -0700
changeset 1658
fdf30b225e1c
parent 1443
cfde9737131e
child 2525
2eb010b6cb22
permissions
-rw-r--r--

8010521: jdk8 l10n resource file translation update 2
Reviewed-by: naoto, yhuang

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

mercurial