ApiDocMacro (sakai-radeox 22.0 API)

java.lang.Object
- org.radeox.macro.BaseMacro
- - org.radeox.macro.BaseLocaleMacro
  - - org.radeox.macro.ApiDocMacro

All Implemented Interfaces:

Comparable, org.radeox.api.macro.Macro, LocaleMacro
```
public class ApiDocMacro
extends BaseLocaleMacro
```

Field Summary
- Fields inherited from class org.radeox.macro.BaseMacro
  description, initialContext

Constructor Summary

Constructors
Constructor Description

ApiDocMacro()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`execute(Writer writer, org.radeox.api.macro.MacroParameter params)`	Execute the macro.
`String`	`getLocaleKey()`
`String[]`	`getParamDescription()`	Get a description of the paramters of the macro.

Methods inherited from class org.radeox.macro.BaseLocaleMacro
getName, setInitialContext

Methods inherited from class org.radeox.macro.BaseMacro
compareTo, getDescription, 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
  - getParamDescription
```
public String[] getParamDescription()
```
    Description copied from class: BaseMacro
    
    Get a description of the paramters of the macro. The method returns an array with an String entry for every parameter. The format is {"1: description", ...} where 1 is the position of the parameter.
    
    Specified by:
    
    getParamDescription in interface org.radeox.api.macro.Macro
    
    Overrides:
    
    getParamDescription in class BaseMacro
    
    Returns:
    
    description Array describing the parameters of the macro
  - getLocaleKey
```
public String getLocaleKey()
```
  - execute
```
public void execute(Writer writer,
                    org.radeox.api.macro.MacroParameter params)
             throws IllegalArgumentException,
                    IOException
```
    Description copied from class: BaseMacro
    
    Execute the macro. This method is called by MacroFilter to handle macros.
    
    Specified by:
    
    execute in interface org.radeox.api.macro.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:
    
    IllegalArgumentException
    
    IOException