org.multijava.mjdoc.mjdoc_142
Class MjdocStandard

java.lang.Object
  com.sun.tools.doclets.standard.Standard
      org.multijava.mjdoc.mjdoc_142.MjdocStandard

public class MjdocStandard

extends com.sun.tools.doclets.standard.Standard

This class is an extension and modification of the Standard doclet, that is the usual javadoc implementation. In the mjdoc tool we provide our own parser and parse tree for (multi-)java, but use the doclet library (with some extensions) in order to render the html. This class provides the connection between the two worlds.

Author:

David R. Cok

Field Summary

 

Fields inherited from class com.sun.tools.doclets.standard.Standard

BUILD_DATE, configuration

 

Constructor Summary

MjdocStandard()

 

Method Summary
static void	copyDocFiles(com.sun.tools.doclets.standard.ConfigurationStandard configuration, String srcDirName, String path, boolean overwrite)
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)
protected  void	generateClassCycle(com.sun.javadoc.ClassDoc[] arr, com.sun.tools.doclets.ClassTree classtree)           Instantiate ClassWriter for each Class within the ClassDoc[] passed to it and generate Documentation for that.
protected  void	generateClassCycle(com.sun.javadoc.ClassDoc[] arr, com.sun.tools.doclets.ClassTree classtree, boolean nopackage)
void	generateEMCUCycle(Iterator i)
protected  void	generateEMCUFiles(com.sun.javadoc.RootDoc root)
String	name()
static boolean	start(com.sun.javadoc.RootDoc root)           The "start" method as required by Javadoc.
protected  void	startGeneration(com.sun.javadoc.RootDoc root)           Start the generation of files.
protected  void	startGenerationSuperMJ(com.sun.javadoc.RootDoc root)           This is the superclass version of startGeneration, which we could use directly except for having to replace some classes by the Mjdoc version.
void	writeGenericFunction(MjMethodDoc top, MjMethodDoc prev, MjMethodDoc next, ArrayList v)           Writes out a specific generic function page.

 

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

MjdocStandard

public MjdocStandard()

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()

startGenerationSuperMJ

protected void startGenerationSuperMJ(com.sun.javadoc.RootDoc root)
                               throws com.sun.tools.doclets.DocletAbortException

This is the superclass version of startGeneration, which we could use directly except for having to replace some classes by the Mjdoc version.

Throws:

com.sun.tools.doclets.DocletAbortException

startGeneration

protected void startGeneration(com.sun.javadoc.RootDoc root)
                        throws com.sun.tools.doclets.DocletAbortException

Start the generation of files. Call generate methods in the individual writers, which will in turn genrate the documentation files. Call the TreeWriter generation first to ensure the Class Hierarchy is built first and then can be used in the later generation. For new format.

Overrides:

startGeneration in class com.sun.tools.doclets.standard.Standard

Throws:

com.sun.tools.doclets.DocletAbortException

See Also:

RootDoc

generateEMCUFiles

protected void generateEMCUFiles(com.sun.javadoc.RootDoc root)

generateEMCUCycle

public void generateEMCUCycle(Iterator i)

writeGenericFunction

public void writeGenericFunction(MjMethodDoc top,
                                 MjMethodDoc prev,
                                 MjMethodDoc next,
                                 ArrayList v)
                          throws com.sun.tools.doclets.DocletAbortException

Writes out a specific generic function page.

Throws:

com.sun.tools.doclets.DocletAbortException

generateClassCycle

protected void generateClassCycle(com.sun.javadoc.ClassDoc[] arr,
                                  com.sun.tools.doclets.ClassTree classtree)

Instantiate ClassWriter for each Class within the ClassDoc[] passed to it and generate Documentation for that. This is overridden simply to be able to use a MjdocClassWriter.

Overrides:

generateClassCycle in class com.sun.tools.doclets.standard.Standard

generateClassCycle

protected void generateClassCycle(com.sun.javadoc.ClassDoc[] arr,
                                  com.sun.tools.doclets.ClassTree classtree,
                                  boolean nopackage)

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)

copyDocFiles

public static void copyDocFiles(com.sun.tools.doclets.standard.ConfigurationStandard configuration,
                                String srcDirName,
                                String path,
                                boolean overwrite)
                         throws com.sun.tools.doclets.DocletAbortException

Throws:

com.sun.tools.doclets.DocletAbortException