/[classpath]/gjdoc/src/com/sun/javadoc/RootDoc.java
ViewVC logotype

Diff of /gjdoc/src/com/sun/javadoc/RootDoc.java

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.1 by mark, Sun Oct 6 21:19:46 2002 UTC revision 1.2 by avdyk, Thu Nov 18 15:18:54 2004 UTC
# Line 1  Line 1 
1  /* RootDoc.java -- Information about a javadoc run.  /* RootDoc.java -- Information about a javadoc run.
2     Copyright (C) 1999 Free Software Foundation, Inc.   Copyright (C) 1999 Free Software Foundation, Inc.
3    
4  This file is part of the com.sun.javadoc implementation of GNU Classpath.   This file is part of the com.sun.javadoc implementation of GNU Classpath.
   
 This program is free software; you can redistribute it and/or modify  
 it under the terms of the GNU General Public License as published  
 by the Free Software Foundation, either version 2 of the License, or  
 (at your option) any later version.  
   
 This program is distributed in the hope that it will be useful, but  
 WITHOUT ANY WARRANTY; without even the implied warranty of  
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the  
 GNU General Public License for more details.  
   
 You should have received a copy of the GNU General Public License  
 along with this program; if not, write to the Free Software Foundation  
 Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307 USA. */  
5    
6     This program is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published
8     by the Free Software Foundation, either version 2 of the License, or
9     (at your option) any later version.
10    
11     This program 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
14     GNU General Public License for more details.
15    
16     You should have received a copy of the GNU General Public License
17     along with this program; if not, write to the Free Software Foundation
18     Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307 USA. */
19    
20  package com.sun.javadoc;  package com.sun.javadoc;
21    
22    /**
23     * This interface is the root of the javadoc application. All the properties and
24     * arguments are attached to the class that will implements this interface. You
25     * can retrieve all the options of the tool with this interface.
26     */
27  public interface RootDoc extends Doc, DocErrorReporter  public interface RootDoc extends Doc, DocErrorReporter
28  {  {
29    
30  /**    /**
31    * This method returns the command line element used to invoke this     * This method returns the command line element used to invoke this instance
32    * instance of javadoc.     * of javadoc.
33    *     *
34    * @return The command line arguments for this run.     * @return The command line arguments for this run.
35    */     */
36  public abstract String[][]    public abstract String[][] options();
37  options();  
38      /** ********************************************************************** */
39  /*************************************************************************/  
40      /**
41  /**     * This method returns the list of packages that were specified on the command
42    * This method returns the list of packages that were specified on the     * line.
43    * command line.     *
44    *     * @return The packages specified on the command line.
45    * @return The packages specified on the command line.     */
46    */    public abstract PackageDoc[] specifiedPackages();
47  public abstract PackageDoc[]  
48  specifiedPackages();    /** ********************************************************************** */
49    
50  /*************************************************************************/    /**
51       * This method returns the list of classes that were specified on the command
52  /**     * line.
53    * This method returns the list of classes that were specified on the     *
54    * command line.     * @return The classes specified on the command line.
55    *     */
56    * @return The classes specified on the command line.    public abstract ClassDoc[] specifiedClasses();
57    */  
58  public abstract ClassDoc[]    /** ********************************************************************** */
59  specifiedClasses();  
60      /**
61  /*************************************************************************/     * This method returns the list of classes and interfaces to be documented.
62       *
63  /**     * @return The list of classes and interfaces to be documented.
64    * This method returns the list of classes and interfaces to be documented.     */
65    *    public abstract ClassDoc[] classes();
66    * @return The list of classes and interfaces to be documented.  
67    */    /** ********************************************************************** */
68  public abstract ClassDoc[]  
69  classes();    /**
70       * This method returns a <code>ClassDoc</code> instance for the name class
71  /*************************************************************************/     * or interface.
72       *
73  /**     * @param name
74    * This method returns a <code>ClassDoc</code> instance for the     *          The class or interface to look up.
75    * name class or interface.     * @return The requested <code>ClassDoc</code>, or null if the specified
76    *     *         class is not part of this javadoc run.
77    * @param name The class or interface to look up.     */
78    *    public abstract ClassDoc classNamed(String name);
79    * @return The requested <code>ClassDoc</code>, or null if the specified  
80    * class is not part of this javadoc run.    /** ********************************************************************** */
81    */  
82  public abstract ClassDoc    /**
83  classNamed(String name);     * This method returns a <code>PackageDoc</code> instance for the named
84       * package.
85  /*************************************************************************/     *
86       * @param name
87  /**     *          The package to look up.
88    * This method returns a <code>PackageDoc</code> instance for the     * @return The requested <code>PackageDoc</code>, or null if the specified
89    * named package.     *         package is not part of this javadoc run.
90    *     */
91    * @param name The package to look up.    public abstract PackageDoc packageNamed(String name);
   *  
   * @return The requested <code>PackageDoc</code>, or null if the specified  
   * package is not part of this javadoc run.  
   */  
 public abstract PackageDoc  
 packageNamed(String name);  
92    
93  } // interface RootDoc  } // interface RootDoc
94    

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26