You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xerces.apache.org by tw...@apache.org on 2002/01/17 07:42:27 UTC
cvs commit: xml-xerces/java/src/org/apache/xml/serialize BaseMarkupSerializer.java HTMLSerializer.java IndentPrinter.java OutputFormat.java Serializer.java
twl 02/01/16 22:42:27
Modified: java/src/org/apache/html/dom NameNodeListImpl.java
java/src/org/apache/xml/serialize BaseMarkupSerializer.java
HTMLSerializer.java IndentPrinter.java
OutputFormat.java Serializer.java
Log:
Javadoc fixes for HTML DOM and Serializers package
Revision Changes Path
1.5 +1 -1 xml-xerces/java/src/org/apache/html/dom/NameNodeListImpl.java
Index: NameNodeListImpl.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/html/dom/NameNodeListImpl.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- NameNodeListImpl.java 4 May 2000 20:50:49 -0000 1.4
+++ NameNodeListImpl.java 17 Jan 2002 06:42:26 -0000 1.5
@@ -123,7 +123,7 @@
* This class implements the DOM's NodeList behavior for
* HTMLDocuemnt.getElementsByName().
*
- * @version
+ * @version $Id: NameNodeListImpl.java,v 1.5 2002/01/17 06:42:26 twl Exp $
* @since PR-DOM-Level-1-19980818.
* @see DeepNodeListImpl
*/
1.32 +9 -5 xml-xerces/java/src/org/apache/xml/serialize/BaseMarkupSerializer.java
Index: BaseMarkupSerializer.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xml/serialize/BaseMarkupSerializer.java,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -r1.31 -r1.32
--- BaseMarkupSerializer.java 12 Jan 2002 00:10:52 -0000 1.31
+++ BaseMarkupSerializer.java 17 Jan 2002 06:42:26 -0000 1.32
@@ -117,7 +117,10 @@
* serializing mechanisms.
* <p>
* The serializer must be initialized with the proper writer and
- * output format before it can be used by calling {@link #init}.
+ * output format before it can be used by calling {@link #setOutputCharStream}
+ * or {@link #setOutputByteStream} for the writer and {@link #setOutputFormat}
+ * for the output format.
+ * <p>
* The serializer can be reused any number of times, but cannot
* be used concurrently by two threads.
* <p>
@@ -149,7 +152,7 @@
* another element.
*
*
- * @version $Revision: 1.31 $ $Date: 2002/01/12 00:10:52 $
+ * @version $Revision: 1.32 $ $Date: 2002/01/17 06:42:26 $
* @author <a href="mailto:arkin@intalio.com">Assaf Arkin</a>
* @author <a href="mailto:rahul.srivastava@sun.com">Rahul Srivastava</a>
* @author Elena Litani, IBM
@@ -275,7 +278,8 @@
/**
* Protected constructor can only be used by derived class.
* Must initialize the serializer before serializing any document,
- * see {@link #init}.
+ * by calling {@link #setOutputCharStream} or {@link #setOutputByteStream}
+ * first
*/
protected BaseMarkupSerializer( OutputFormat format )
{
@@ -1323,7 +1327,7 @@
/**
* Called to print additional text with whitespace handling.
* If spaces are preserved, the text is printed as if by calling
- * {@link #printText(String)} with a call to {@link #breakLine}
+ * {@link #printText(String,boolean,boolean)} with a call to {@link Printer#breakLine}
* for each new line. If spaces are not preserved, the text is
* broken at space boundaries if longer than the line width;
* Multiple spaces are printed as such, but spaces at beginning
@@ -1621,7 +1625,7 @@
*
* @param message
* @param severity
- * @return
+ * @return a DOMError
*/
protected DOMError modifyDOMError(String message, short severity){
fDOMError.reset();
1.17 +2 -2 xml-xerces/java/src/org/apache/xml/serialize/HTMLSerializer.java
Index: HTMLSerializer.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xml/serialize/HTMLSerializer.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- HTMLSerializer.java 7 Nov 2001 19:02:55 -0000 1.16
+++ HTMLSerializer.java 17 Jan 2002 06:42:26 -0000 1.17
@@ -125,7 +125,7 @@
* </ul>
*
*
- * @version $Revision: 1.16 $ $Date: 2001/11/07 19:02:55 $
+ * @version $Revision: 1.17 $ $Date: 2002/01/17 06:42:26 $
* @author <a href="mailto:arkin@intalio.com">Assaf Arkin</a>
* @see Serializer
*/
@@ -148,7 +148,7 @@
/**
* Constructs a new HTML/XHTML serializer depending on the value of
* <tt>xhtml</tt>. The serializer cannot be used without calling
- * {@link #init} first.
+ * {@link #setOutputCharStream} or {@link #setOutputByteStream} first.
*
* @param xhtml True if XHTML serializing
*/
1.6 +2 -2 xml-xerces/java/src/org/apache/xml/serialize/IndentPrinter.java
Index: IndentPrinter.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xml/serialize/IndentPrinter.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- IndentPrinter.java 6 Dec 2001 21:00:06 -0000 1.5
+++ IndentPrinter.java 17 Jan 2002 06:42:26 -0000 1.6
@@ -68,7 +68,7 @@
* Extends {@link Printer} and adds support for indentation and line
* wrapping.
*
- * @version $Revision: 1.5 $ $Date: 2001/12/06 21:00:06 $
+ * @version $Revision: 1.6 $ $Date: 2002/01/17 06:42:26 $
* @author <a href="mailto:arkin@intalio.com">Assaf Arkin</a>
*/
public class IndentPrinter
@@ -299,7 +299,7 @@
* to accumulate the next line. This method is called by {@link
* #printText} and {@link #printSpace} when the accumulated line plus
* accumulated text are two long to fit on a given line. At the end of
- * this method {@link #_line} is empty and {@link #_spaces} is zero.
+ * this method _line is empty and _spaces is zero.
*/
public void flushLine( boolean preserveSpace )
{
1.14 +3 -3 xml-xerces/java/src/org/apache/xml/serialize/OutputFormat.java
Index: OutputFormat.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xml/serialize/OutputFormat.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- OutputFormat.java 15 Jan 2002 20:22:26 -0000 1.13
+++ OutputFormat.java 17 Jan 2002 06:42:26 -0000 1.14
@@ -91,7 +91,7 @@
* </ul>
*
*
- * @version $Revision: 1.13 $ $Date: 2002/01/15 20:22:26 $
+ * @version $Revision: 1.14 $ $Date: 2002/01/17 06:42:26 $
* @author <a href="mailto:arkin@intalio.com">Assaf Arkin</a>
* <a href="mailto:visco@intalio.com">Keith Visco</a>
* @see Serializer
@@ -441,7 +441,7 @@
/**
* Sets the indentation on and off. When set on, the default
* indentation level and default line wrapping is used
- * (see {@link #DEFAULT_INDENT} and {@link #DEFAULT_LINE_WIDTH}).
+ * (see {@link Defaults#Indent} and {@link Defaults#LineWidth}).
* To specify a different indentation level or line wrapping,
* use {@link #setIndent} and {@link #setLineWidth}.
*
@@ -498,7 +498,7 @@
/**
* Returns an <code>EncodingInfo<code> instance for the encoding.
*
- * @see setEncoding
+ * @see #setEncoding
*/
public EncodingInfo getEncodingInfo() {
if (_encodingInfo == null)
1.11 +3 -3 xml-xerces/java/src/org/apache/xml/serialize/Serializer.java
Index: Serializer.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xml/serialize/Serializer.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- Serializer.java 15 Jan 2002 17:21:38 -0000 1.10
+++ Serializer.java 17 Jan 2002 06:42:27 -0000 1.11
@@ -78,8 +78,8 @@
* and pass it around as a {@link
* org.xml.sax.DocumentHandler}. If an I/O error occurs while serializing, it will
* be thrown by {@link DocumentHandler#endDocument}. The SAX serializer
- * may also be used as {@link org.xml.sax.DTDHandler}, {@link org.xml.sax.DeclHandler} and
- * {@link org.xml.sax.LexicalHandler}.
+ * may also be used as {@link org.xml.sax.DTDHandler}, {@link org.xml.sax.ext.DeclHandler} and
+ * {@link org.xml.sax.ext.LexicalHandler}.
* <p>
* To serialize a DOM document or DOM element, create a compatible
* serializer and call it's {@link
@@ -94,7 +94,7 @@
* UTF-8 encoding and now indentation.
*
*
- * @version $Revision: 1.10 $ $Date: 2002/01/15 17:21:38 $
+ * @version $Revision: 1.11 $ $Date: 2002/01/17 06:42:27 $
* @author <a href="mailto:arkin@intalio.com">Assaf Arkin</a>
* @author <a href="mailto:Scott_Boag/CAM/Lotus@lotus.com">Scott Boag</a>
* @see DocumentHandler
---------------------------------------------------------------------
To unsubscribe, e-mail: xerces-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: xerces-cvs-help@xml.apache.org