|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.doxia.macro.AbstractMacro
org.apache.maven.doxia.macro.toc.TocMacro
public class TocMacro
Macro to display a Table Of Content
in a given Sink
.
The input parameters for this macro are:
* {SubSection 1}Similarly, in an XDOC file, you could write:
<macro name="toc"> <param name="section" value="1" /> <param name="fromDepth" value="1" /> <param name="toDepth" value="2" /> </macro>
Field Summary |
---|
Fields inherited from interface org.apache.maven.doxia.macro.Macro |
---|
EOL, ROLE |
Constructor Summary | |
---|---|
TocMacro()
|
Method Summary | |
---|---|
void |
execute(Sink sink,
MacroRequest request)
Execute the current macro using the given MacroRequest, and emit events into the given sink. |
Methods inherited from class org.apache.maven.doxia.macro.AbstractMacro |
---|
enableLogging, getAttributesFromMap, getLog, required |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TocMacro()
Method Detail |
---|
public void execute(Sink sink, MacroRequest request) throws MacroExecutionException
sink
- The sink to receive the events.request
- The corresponding MacroRequest.
MacroExecutionException
- if an error occurred during execution.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |