org.radeox.macro
Class ApiDocMacro

java.lang.Object
  extended by org.radeox.macro.BaseMacro
      extended by org.radeox.macro.BaseLocaleMacro
          extended by org.radeox.macro.ApiDocMacro
All Implemented Interfaces:
java.lang.Comparable, LocaleMacro, Macro

public class ApiDocMacro
extends BaseLocaleMacro


Field Summary
 
Fields inherited from class org.radeox.macro.BaseMacro
description, initialContext, paramDescription
 
Constructor Summary
ApiDocMacro()
           
 
Method Summary
 void execute(java.io.Writer writer, MacroParameter params)
          Execute the macro.
 java.lang.String getLocaleKey()
           
 
Methods inherited from class org.radeox.macro.BaseLocaleMacro
getDescription, getName, getParamDescription, setInitialContext
 
Methods inherited from class org.radeox.macro.BaseMacro
compareTo, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ApiDocMacro

public ApiDocMacro()
Method Detail

getLocaleKey

public java.lang.String getLocaleKey()

execute

public void execute(java.io.Writer writer,
                    MacroParameter params)
             throws java.lang.IllegalArgumentException,
                    java.io.IOException
Description copied from class: BaseMacro
Execute the macro. This method is called by MacroFilter to handle macros.

Specified by:
execute in interface Macro
Specified by:
execute in class BaseMacro
Parameters:
writer - A write where the macro should write its output to
params - Macro parameters with the parameters the macro is called with
Throws:
java.lang.IllegalArgumentException
java.io.IOException