Author: vsiveton
Date: Mon Oct 27 04:46:40 2008
New Revision: 708149
URL: http://svn.apache.org/viewvc?rev=708149&view=rev
Log:
o javadoc about UTF-8 encoding
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceSink.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-latex/src/main/java/org/apache/maven/doxia/module/latex/LatexSink.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiSink.java
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceSink.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceSink.java?rev=708149&r1=708148&r2=708149&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceSink.java
(original)
+++
maven/doxia/doxia/trunk/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceSink.java
Mon Oct 27 04:46:40 2008
@@ -31,6 +31,8 @@
/**
* Confluence Sink implementation.
+ * <br/>
+ * <b>Note</b>: The encoding used is UTF-8.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Vincent Siveton</a>
* @version $Id$
@@ -64,7 +66,10 @@
private String linkName;
/**
- * @param writer writer not null
+ * Constructor, initialize the Writer and the variables.
+ *
+ * @param writer not null writer to write the result. <b>Should</b> be an
UTF-8 Writer.
+ * You could use <code>newWriter</code> methods from [EMAIL PROTECTED]
org.codehaus.plexus.util.WriterFactory}.
*/
public ConfluenceSink( Writer writer )
{
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-latex/src/main/java/org/apache/maven/doxia/module/latex/LatexSink.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-latex/src/main/java/org/apache/maven/doxia/module/latex/LatexSink.java?rev=708149&r1=708148&r2=708149&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-modules/doxia-module-latex/src/main/java/org/apache/maven/doxia/module/latex/LatexSink.java
(original)
+++
maven/doxia/doxia/trunk/doxia-modules/doxia-module-latex/src/main/java/org/apache/maven/doxia/module/latex/LatexSink.java
Mon Oct 27 04:46:40 2008
@@ -34,6 +34,8 @@
/**
* Latex Sink implementation.
+ * <br/>
+ * <b>Note</b>: The encoding used is UTF-8.
*
* @version $Id$
* @since 1.0
@@ -83,9 +85,10 @@
// ----------------------------------------------------------------------
/**
- * Constructor.
+ * Constructor, initialize the Writer and the variables.
*
- * @param out The writer to use.
+ * @param out not null writer to write the result. <b>Should</b> be an
UTF-8 Writer.
+ * You could use <code>newWriter</code> methods from [EMAIL PROTECTED]
org.codehaus.plexus.util.WriterFactory}.
*/
public LatexSink( Writer out )
{
@@ -95,9 +98,10 @@
}
/**
- * Constructor.
+ * Constructor, initialize the Writer and the variables.
*
- * @param out The writer to use.
+ * @param out not null writer to write the result. <b>Should</b> be an
UTF-8 Writer.
+ * You could use <code>newWriter</code> methods from [EMAIL PROTECTED]
org.codehaus.plexus.util.WriterFactory}.
* @param sinkCommands A String representation of commands that go before
\documentclass.
* @param preamble A String representation of commands that go between
\documentclass and \begin{document}.
*/
@@ -107,13 +111,15 @@
}
/**
- * Constructor.
+ * Constructor, initialize the Writer and the variables.
*
- * @param out The writer to use.
+ * @param out not null writer to write the result. <b>Should</b> be an
UTF-8 Writer.
+ * You could use <code>newWriter</code> methods from [EMAIL PROTECTED]
org.codehaus.plexus.util.WriterFactory}.
* @param sinkCommands A String representation of commands that go before
\documentclass.
* @param preamble A String representation of commands that go between
\documentclass and \begin{document}.
* @param fragmentDocument If this receives events that that are only part
of a document.
- * Typically, headers are omitted if this is true. */
+ * Typically, headers are omitted if this is true.
+ */
public LatexSink( Writer out, String sinkCommands, String preamble,
boolean fragmentDocument )
{
this.out = new LineBreaker( out );
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiSink.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiSink.java?rev=708149&r1=708148&r2=708149&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiSink.java
(original)
+++
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiSink.java
Mon Oct 27 04:46:40 2008
@@ -38,6 +38,8 @@
/**
* TWiki Sink implementation.
+ * <br/>
+ * <b>Note</b>: The encoding used is UTF-8.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Vincent Siveton</a>
* @version $Id$
@@ -68,7 +70,10 @@
private Stack listStyles;
/**
- * @param writer writer not null
+ * Constructor, initialize the Writer and the variables.
+ *
+ * @param writer not null writer to write the result. <b>Should</b> be an
UTF-8 Writer.
+ * You could use <code>newWriter</code> methods from [EMAIL PROTECTED]
org.codehaus.plexus.util.WriterFactory}.
*/
public TWikiSink( Writer writer )
{
