org.radeox.macro.api

Class ApiDoc

java.lang.Object

org.radeox.macro.api.ApiDoc

public class ApiDoc
extends Object

Stores information and links to api documentation, e.g. for Java, Ruby, JBoss

Version:

$Id: ApiDoc.java 20417 2007-01-18 18:14:15Z ian@caret.cam.ac.uk $

Author:

Stephan J. Schmidt

Constructor Summary

Constructors

Constructor and Description
ApiDoc()

Method Summary

Methods

Modifier and Type	Method and Description
void	addApiDoc(BufferedReader reader)
Writer	appendTo(Writer writer)
boolean	contains(String external)
Writer	expand(Writer writer, String className, String mode)
static ApiDoc	getInstance()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiDoc

public ApiDoc()

Method Detail

getInstance

public static ApiDoc getInstance()

addApiDoc

public void addApiDoc(BufferedReader reader)
               throws IOException

Throws:

IOException

contains

public boolean contains(String external)

expand

public Writer expand(Writer writer,
            String className,
            String mode)
              throws IOException

Throws:

IOException

appendTo

public Writer appendTo(Writer writer)
                throws IOException

Throws:

IOException