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

Tue, 16 Sep 2008 18:35:18 -0700

author
jjg
date
Tue, 16 Sep 2008 18:35:18 -0700
changeset 113
eff38cc97183
parent 1
9a66ca7c79fa
child 554
9d9f26857129
permissions
-rw-r--r--

6574134: Allow for alternative implementation of Name Table with garbage collection of name bytes
Reviewed-by: darcy, mcimadamore

duke@1 1 /*
duke@1 2 * Copyright 1997-2005 Sun Microsystems, Inc. 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
duke@1 7 * published by the Free Software Foundation. Sun designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
duke@1 9 * by Sun 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 *
duke@1 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 22 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 23 * have any 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
duke@1 30 import com.sun.tools.javac.code.Symbol;
duke@1 31 import com.sun.tools.javac.tree.JCTree;
duke@1 32 import com.sun.tools.javac.util.Position;
duke@1 33
duke@1 34 /**
duke@1 35 * Represents a member of a java class: field, constructor, or method.
duke@1 36 * This is an abstract class dealing with information common to
duke@1 37 * method, constructor and field members. Class members of a class
duke@1 38 * (nested classes) are represented instead by ClassDocImpl.
duke@1 39 *
duke@1 40 * @see MethodDocImpl
duke@1 41 * @see FieldDocImpl
duke@1 42 * @see ClassDocImpl
duke@1 43 *
duke@1 44 * @author Robert Field
duke@1 45 * @author Neal Gafter
duke@1 46 */
duke@1 47
duke@1 48 public abstract class MemberDocImpl
duke@1 49 extends ProgramElementDocImpl
duke@1 50 implements MemberDoc {
duke@1 51
duke@1 52 /**
duke@1 53 * constructor.
duke@1 54 */
duke@1 55 public MemberDocImpl(DocEnv env, Symbol sym, String doc, JCTree tree, Position.LineMap lineMap) {
duke@1 56 super(env, sym, doc, tree, lineMap);
duke@1 57 }
duke@1 58
duke@1 59 /**
duke@1 60 * Returns true if this field was synthesized by the compiler.
duke@1 61 */
duke@1 62 public abstract boolean isSynthetic();
duke@1 63 }

mercurial