You are viewing a plain text version of this content. The canonical link for it is here.
Posted to doxia-commits@maven.apache.org by vs...@apache.org on 2007/07/31 14:50:43 UTC
svn commit: r561315 -
/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java
Author: vsiveton
Date: Tue Jul 31 05:50:41 2007
New Revision: 561315
URL: http://svn.apache.org/viewvc?view=rev&rev=561315
Log:
DOXIA-130: Macro renaming
o updated doc
Modified:
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java
Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java?view=diff&rev=561315&r1=561314&r2=561315
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java (original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java Tue Jul 31 05:50:41 2007
@@ -39,7 +39,7 @@
* <dl>
* <dt>section</dt>
* <dd>Display the specificated section number or all sections if 0
- * (in this case, other paramaters are ignored).<br/>
+ * (in this case, other parameters are ignored).<br/>
* Positive int, not mandatory, 0 by default.</dd>
* <dt>fromDepth</dt>
* <dd>Display the depth starting for the given section number.<br/>
@@ -63,9 +63,13 @@
* * {SubSection 1}
* </pre>
*
- * Similary, in an XDOC file, you could write:
+ * Similarly, in an XDOC file, you could write:
* <pre>
- * <macro name="toc" section="1" fromDepth="1" toDepth="2"/>
+ * <macro name="toc">
+ * <param name="section" value="1" />
+ * <param name="fromDepth" value="1" />
+ * <param name="toDepth" value="2" />
+ * </macro>
* </pre>
*
* @plexus.component role-hint="toc"