1 /*

     2  * Copyright 1998 Sun Microsystems, Inc.  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.  Sun designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

    22  * CA 95054 USA or visit www.sun.com if you need additional information or

    23  * have any questions.

    24  */

    25 

    26 package com.sun.javadoc;

    27 

    28 /**

    29  * Represents a member of a java class: field, constructor, or method.

    30  * This is an abstract class dealing with information common to

    31  * method, constructor and field members. Class members of a class

    32  * (innerclasses) are represented instead by ClassDoc.

    33  *

    34  * @see MethodDoc

    35  * @see FieldDoc

    36  * @see ClassDoc

    37  *

    38  * @author Kaiyang Liu (original)

    39  * @author Robert Field (rewrite)

    40  */

    41 public interface MemberDoc extends ProgramElementDoc {

    42 

    43     /**

    44      * Returns true if this member was synthesized by the compiler.

    45      */

    46     boolean isSynthetic();

    47 }