• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 1998, 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 
26 package com.sun.javadoc;
27 
28 import com.google.doclava.annotation.Used;
29 
30 /**
31  * Represents a member of a java class: field, constructor, or method.
32  * This is an abstract class dealing with information common to
33  * method, constructor and field members. Class members of a class
34  * (innerclasses) are represented instead by ClassDoc.
35  *
36  * @see MethodDoc
37  * @see FieldDoc
38  * @see ClassDoc
39  *
40  * @author Kaiyang Liu (original)
41  * @author Robert Field (rewrite)
42  */
43 public interface MemberDoc extends ProgramElementDoc {
44 
45     /**
46      * Returns true if this member was synthesized by the compiler.
47      */
48     @Used
isSynthetic()49     boolean isSynthetic();
50 }
51