Author: vsiveton
Date: Sat May 16 17:06:39 2009
New Revision: 775496
URL: http://svn.apache.org/viewvc?rev=775496&view=rev
Log:
o improved javadoc
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoAggregateSink.java
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoAggregateSink.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoAggregateSink.java?rev=775496&r1=775495&r2=775496&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoAggregateSink.java
(original)
+++
maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoAggregateSink.java
Sat May 16 17:06:39 2009
@@ -42,7 +42,21 @@
import org.codehaus.plexus.util.StringUtils;
/**
- * A Doxia Sink that produces an aggregated FO model.
+ * A Doxia Sink that produces an aggregated FO model. The usage is similar to
the following:
+ *
+ * <pre>
+ * FoAggregateSink sink = new FoAggregateSink( writer );
+ * sink.setDocumentModel( documentModel );
+ * sink.beginDocument();
+ * sink.coverPage();
+ * sink.toc();
+ * ...
+ * sink.endDocument();
+ * </pre>
+ *
+ * <b>Note</b>: the documentModel object contains several
+ * <a
href="http://maven.apache.org/doxia/doxia/doxia-core/document.html";>document
metadata</a>, but only a few
+ * of them are used in this sink (i.e. author and title), the others are
ignored.
*
* @author ltheussl
* @version $Id$
