JML

org.jmlspecs.jmldoc.jmldoc_142
Class JmldocStandard

java.lang.Object
  extended bycom.sun.tools.doclets.standard.Standard
      extended byorg.multijava.mjdoc.mjdoc_142.MjdocStandard
          extended byorg.jmlspecs.jmldoc.jmldoc_142.JmldocStandard

public class JmldocStandard
extends org.multijava.mjdoc.mjdoc_142.MjdocStandard

The class with "start" method, calls individual Writers.

Author:
Atul M Dambalkar, Robert Field

Field Summary
 
Fields inherited from class com.sun.tools.doclets.standard.Standard
BUILD_DATE, configuration
 
Constructor Summary
JmldocStandard()
           
 
Method Summary
protected  void generateClass(com.sun.tools.doclets.standard.ConfigurationStandard configuration, com.sun.javadoc.ClassDoc curr, com.sun.javadoc.ClassDoc prev, com.sun.javadoc.ClassDoc next, com.sun.tools.doclets.ClassTree classtree, boolean nopackage)
          Instantiate ClassWriter for each Class within the ClassDoc[] passed to it and generate Documentation for that.
 String name()
           
static boolean start(com.sun.javadoc.RootDoc root)
          The "start" method as required by Javadoc.
 
Methods inherited from class org.multijava.mjdoc.mjdoc_142.MjdocStandard
copyDocFiles, generateClassCycle, generateClassCycle, generateEMCUCycle, generateEMCUFiles, startGeneration, startGenerationSuperMJ, writeGenericFunction
 
Methods inherited from class com.sun.tools.doclets.standard.Standard
classFileName, configuration, generateClassCycle, generateClassFiles, generateSerializedFormPage, optionLength, performCopy, validOptions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JmldocStandard

public JmldocStandard()
Method Detail

start

public static boolean start(com.sun.javadoc.RootDoc root)
                     throws IOException
The "start" method as required by Javadoc.

Parameters:
root -
Returns:
boolean true indicates a successful generation of html
Throws:
IOException
See Also:
RootDoc

name

public String name()
Overrides:
name in class org.multijava.mjdoc.mjdoc_142.MjdocStandard

generateClass

protected void generateClass(com.sun.tools.doclets.standard.ConfigurationStandard configuration,
                             com.sun.javadoc.ClassDoc curr,
                             com.sun.javadoc.ClassDoc prev,
                             com.sun.javadoc.ClassDoc next,
                             com.sun.tools.doclets.ClassTree classtree,
                             boolean nopackage)
Instantiate ClassWriter for each Class within the ClassDoc[] passed to it and generate Documentation for that. The looping control is in MjdocStandard; this is overridden simply to be able to use a JmldocClassWriter.

Overrides:
generateClass in class org.multijava.mjdoc.mjdoc_142.MjdocStandard

JML

JML is Copyright (C) 1998-2002 by Iowa State University and is distributed under 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 release depends on code from the MultiJava project and is based in part on the Kopi project Copyright (C) 1990-99 DMS Decision Management Systems Ges.m.b.H.