JmldocStandard (JML and MultiJava documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

JML

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jmlspecs.jmldoc.jmldoc_142
Class JmldocStandard

java.lang.Object
  com.sun.tools.doclets.standard.Standard
      org.multijava.mjdoc.mjdoc_142.MjdocStandard
          org.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