public abstract class

ApiPage

extends Object

implements IDocPage

 java.lang.Object

↳com.parrot.docdown.data.page.ApiPage

Subclasses:

PackagePage, PackageListPage, ClassPage

Overview

Base class for a page on Api (versus markdown poage).

Summary

Fields
private final PathdestFilePath

Constructors
publicApiPage(Path outDirPath, String fileName)

publicApiPage(Path outDirPath, String packageName, String fileName)

Methods
public WritercreateWriter()

public abstract com.sun.javadoc.ClassDocgetClassDoc()

public abstract com.sun.javadoc.PackageDocgetPackageDoc()

public StringgetReferenceFrom(Path from)

public StringgetReferenceTo(DocReferenceable referenceable)

public StringgetReferenceTo(Path to)

from Object, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Fields

private final Path destFilePath

Constructors

public ApiPage(Path outDirPath, String packageName, String fileName)

public ApiPage(Path outDirPath, String fileName)

Methods

public abstract com.sun.javadoc.PackageDoc getPackageDoc()

public abstract com.sun.javadoc.ClassDoc getClassDoc()

public String getReferenceTo(DocReferenceable referenceable)

public String getReferenceTo(Path to)

public String getReferenceFrom(Path from)

public Writer createWriter()