public abstract class

DocGenerator

extends Object

java.lang.Object

↳com.parrot.docdown.DocGenerator

Subclasses:

DefaultGenerator

Overview

Base class for a docdown documentation generator.

Subclass must implements the method that generate the actual documentation

Summary

Fields
protected final DocdownOption	options
protected final RefLocator	refLocator
protected final com.sun.javadoc.RootDoc	rootDoc
protected final RootProjectDoc	rootProjectDoc
protected final DocPageStore	store
protected final String	title

Constructors
public	DocGenerator(com.sun.javadoc.RootDoc rootDoc, RootProjectDoc rootProjectDoc, RefLocator refLocator, DocdownOption options, DocPageStore store, String title)

Methods
public abstract boolean	generate(com.sun.javadoc.PackageDoc packages[], com.sun.javadoc.ClassDoc classes[], MarkupDoc markups[], ResourceDoc resources[])
public RefLocator	getRefLocator()
public com.sun.javadoc.RootDoc	getRootDoc()
public RootProjectDoc	getRootProjectDoc()
public String	getTitle()
from Object	, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Fields

protected final RefLocator refLocator

protected final DocPageStore store

protected final DocdownOption options

protected final com.sun.javadoc.RootDoc rootDoc

protected final RootProjectDoc rootProjectDoc

protected final String title

Constructors

public DocGenerator(com.sun.javadoc.RootDoc rootDoc, RootProjectDoc rootProjectDoc, RefLocator refLocator, DocdownOption options, DocPageStore store, String title)

Methods

public RefLocator getRefLocator()

public com.sun.javadoc.RootDoc getRootDoc()

public RootProjectDoc getRootProjectDoc()

public String getTitle()

public abstract boolean generate(com.sun.javadoc.PackageDoc packages[], com.sun.javadoc.ClassDoc classes[], MarkupDoc markups[], ResourceDoc resources[])