Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javadoc/MemberDocImpl.java@78962d89f283 (annotated)
src/share/classes/com/sun/tools/javadoc/MemberDocImpl.java
Tue, 23 Oct 2012 13:20:37 -0700
- author
- jjg
- date
- Tue, 23 Oct 2012 13:20:37 -0700
- changeset 1372
- 78962d89f283
- parent 1359
- 25e14ad23cef
- child 1443
- cfde9737131e
- permissions
- -rw-r--r--
8000741: refactor javadoc to use abstraction to handle relative paths
Reviewed-by: darcy
| 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 | |
| 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 | * |
| jjg@1359 | 40 | * <p><b>This is NOT part of any supported API. |
| jjg@1359 | 41 | * If you write code that depends on this, you do so at your own risk. |
| jjg@1359 | 42 | * This code and its internal interfaces are subject to change or |
| jjg@1359 | 43 | * deletion without notice.</b> |
| jjg@1359 | 44 | * |
| duke@1 | 45 | * @see MethodDocImpl |
| duke@1 | 46 | * @see FieldDocImpl |
| duke@1 | 47 | * @see ClassDocImpl |
| duke@1 | 48 | * |
| duke@1 | 49 | * @author Robert Field |
| duke@1 | 50 | * @author Neal Gafter |
| duke@1 | 51 | */ |
| duke@1 | 52 | |
| duke@1 | 53 | public abstract class MemberDocImpl |
| duke@1 | 54 | extends ProgramElementDocImpl |
| duke@1 | 55 | implements MemberDoc { |
| duke@1 | 56 | |
| duke@1 | 57 | /** |
| duke@1 | 58 | * constructor. |
| duke@1 | 59 | */ |
| duke@1 | 60 | public MemberDocImpl(DocEnv env, Symbol sym, String doc, JCTree tree, Position.LineMap lineMap) { |
| duke@1 | 61 | super(env, sym, doc, tree, lineMap); |
| duke@1 | 62 | } |
| duke@1 | 63 | |
| duke@1 | 64 | /** |
| duke@1 | 65 | * Returns true if this field was synthesized by the compiler. |
| duke@1 | 66 | */ |
| duke@1 | 67 | public abstract boolean isSynthetic(); |
| duke@1 | 68 | } |
