trunk/libjava/classpath/tools/com/sun/javadoc/MethodDoc.java

   1 /* MethodDoc.java -- Document a method
   2    Copyright (C) 1999 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package com.sun.javadoc;
  40
  41 /**
  42   * This interface is used for documenting ordinary (ie, non-constructor)
  43   * methods.
  44   */
  45 public interface MethodDoc extends ExecutableMemberDoc
  46 {
  47
  48 /**
  49   * This method tests whether or not the method to be documented is abstract.
  50   *
  51   * @return <code>true</code> if the method is abstract, <code>false</code>
  52   * otherwise.
  53   */
  54 public abstract boolean
  55 isAbstract();
  56
  57 /*************************************************************************/
  58
  59 /**
  60   * This method returns the return type of the method to be documented.
  61   *
  62   * @return The return type of the method to be documented.
  63   */
  64 public abstract Type
  65 returnType();
  66
  67 /*************************************************************************/
  68
  69 /**
  70   * This method returns the class containing the method that this method is
  71   * overriding.
  72   *
  73   * @return The class containing the method that this method is overriding,
  74   * or <code>null</code> if this class is not overriding a method.
  75   */
  76 public abstract ClassDoc
  77 overriddenClass();
  78
  79 } // interface MethodDoc
  80