Author: ltheussl
Date: Thu Jul 19 02:42:53 2007
New Revision: 557537
URL: http://svn.apache.org/viewvc?view=rev&rev=557537
Log:
Javadocs, source formatting. No code changes.
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSiteModule.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XmlWriterXdocSink.java
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java?view=diff&rev=557537&r1=557536&r2=557537
==============================================================================
---
maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java
(original)
+++
maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java
Thu Jul 19 02:42:53 2007
@@ -35,12 +35,16 @@
public class XdocSink
extends SinkAdapter
{
+ /** System-dependent EOL. */
protected static final String EOL = System.getProperty( "line.separator" );
+ /** The LineBreaker to write the result. */
protected LineBreaker out;
+ /** Used to collect text events. */
protected StringBuffer buffer = new StringBuffer();
+ /** An indication on if we're inside a head. */
protected boolean headFlag;
/**
@@ -50,23 +54,34 @@
*/
protected boolean titleFlag;
+ /** An indication on if we're inside a item. */
private boolean itemFlag;
+ /** An indication on if we're inside a box (verbatim). */
private boolean boxedFlag;
+ /** An indication on if we're in verbatim mode. */
private boolean verbatimFlag;
+ /** Justification of table cells. */
private int[] cellJustif;
+ /** Number of cells in a table row. */
private int cellCount;
- private String section;
-
- public XdocSink( Writer out )
+ /**
+ * Constructor, initialize the LineBreaker.
+ *
+ * @param writer The writer to write the result.
+ */
+ public XdocSink( Writer writer )
{
- this.out = new LineBreaker( out );
+ this.out = new LineBreaker( writer );
}
+ /**
+ * Reset all variables.
+ */
protected void resetState()
{
headFlag = false;
@@ -78,6 +93,7 @@
cellCount = 0;
}
+ /** [EMAIL PROTECTED] */
public void head()
{
resetState();
@@ -91,6 +107,7 @@
markup( "<properties>" + EOL );
}
+ /** [EMAIL PROTECTED] */
public void head_()
{
headFlag = false;
@@ -98,6 +115,7 @@
markup( "</properties>" + EOL );
}
+ /** [EMAIL PROTECTED] */
public void title_()
{
if ( buffer.length() > 0 )
@@ -109,6 +127,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void author_()
{
if ( buffer.length() > 0 )
@@ -120,6 +139,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void date_()
{
if ( buffer.length() > 0 )
@@ -131,11 +151,13 @@
}
}
+ /** [EMAIL PROTECTED] */
public void body()
{
markup( "<body>" + EOL );
}
+ /** [EMAIL PROTECTED] */
public void body_()
{
markup( "</body>" + EOL );
@@ -151,106 +173,131 @@
//
// -----------------------------------------------------------------------
+ /** [EMAIL PROTECTED] */
public void section1()
{
onSection( 1 );
}
+ /** [EMAIL PROTECTED] */
public void sectionTitle1()
{
onSectionTitle( 1 );
}
+ /** [EMAIL PROTECTED] */
public void sectionTitle1_()
{
onSectionTitle_( 1 );
}
+ /** [EMAIL PROTECTED] */
public void section1_()
{
onSection_( 1 );
}
+ /** [EMAIL PROTECTED] */
public void section2()
{
onSection( 2 );
}
+ /** [EMAIL PROTECTED] */
public void sectionTitle2()
{
onSectionTitle( 2 );
}
+ /** [EMAIL PROTECTED] */
public void sectionTitle2_()
{
onSectionTitle_( 2 );
}
+ /** [EMAIL PROTECTED] */
public void section2_()
{
onSection_( 2 );
}
+ /** [EMAIL PROTECTED] */
public void section3()
{
onSection( 3 );
}
+ /** [EMAIL PROTECTED] */
public void sectionTitle3()
{
onSectionTitle( 3 );
}
+ /** [EMAIL PROTECTED] */
public void sectionTitle3_()
{
onSectionTitle_( 3 );
}
+ /** [EMAIL PROTECTED] */
public void section3_()
{
onSection_( 3 );
}
+ /** [EMAIL PROTECTED] */
public void section4()
{
onSection( 4 );
}
+ /** [EMAIL PROTECTED] */
public void sectionTitle4()
{
onSectionTitle( 4 );
}
+ /** [EMAIL PROTECTED] */
public void sectionTitle4_()
{
onSectionTitle_( 4 );
}
+ /** [EMAIL PROTECTED] */
public void section4_()
{
onSection_( 4 );
}
+ /** [EMAIL PROTECTED] */
public void section5()
{
onSection( 5 );
}
+ /** [EMAIL PROTECTED] */
public void sectionTitle5()
{
onSectionTitle( 5 );
}
+ /** [EMAIL PROTECTED] */
public void sectionTitle5_()
{
onSectionTitle_( 5 );
}
+ /** [EMAIL PROTECTED] */
public void section5_()
{
onSection_( 5 );
}
+ /**
+ * Starts a section.
+ *
+ * @param depth The level of the section.
+ */
private void onSection( int depth )
{
if ( depth == 1 )
@@ -263,6 +310,11 @@
}
}
+ /**
+ * Starts a section title.
+ *
+ * @param depth The level of the section title.
+ */
private void onSectionTitle( int depth )
{
if ( depth == 3 )
@@ -281,6 +333,11 @@
titleFlag = true;
}
+ /**
+ * Ends a section title.
+ *
+ * @param depth The level of the section title.
+ */
private void onSectionTitle_( int depth )
{
if ( depth == 1 || depth == 2 )
@@ -303,6 +360,11 @@
titleFlag = false;
}
+ /**
+ * Ends a section.
+ *
+ * @param depth The level of the section.
+ */
private void onSection_( int depth )
{
if ( depth == 1 )
@@ -319,17 +381,20 @@
//
// -----------------------------------------------------------------------
+ /** [EMAIL PROTECTED] */
public void list()
{
markup( "<ul>" + EOL );
}
+ /** [EMAIL PROTECTED] */
public void list_()
{
markup( "</ul>" );
itemFlag = false;
}
+ /** [EMAIL PROTECTED] */
public void listItem()
{
markup( "<li>" );
@@ -337,11 +402,13 @@
// What follows is at least a paragraph.
}
+ /** [EMAIL PROTECTED] */
public void listItem_()
{
markup( "</li>" + EOL );
}
+ /** [EMAIL PROTECTED] */
public void numberedList( int numbering )
{
String style;
@@ -366,12 +433,14 @@
markup( "<ol style=\"list-style-type: " + style + "\">" + EOL );
}
+ /** [EMAIL PROTECTED] */
public void numberedList_()
{
markup( "</ol>" );
itemFlag = false;
}
+ /** [EMAIL PROTECTED] */
public void numberedListItem()
{
markup( "<li>" );
@@ -379,32 +448,38 @@
// What follows is at least a paragraph.
}
+ /** [EMAIL PROTECTED] */
public void numberedListItem_()
{
markup( "</li>" + EOL );
}
+ /** [EMAIL PROTECTED] */
public void definitionList()
{
markup( "<dl>" + EOL );
}
+ /** [EMAIL PROTECTED] */
public void definitionList_()
{
markup( "</dl>" );
itemFlag = false;
}
+ /** [EMAIL PROTECTED] */
public void definedTerm()
{
markup( "<dt>" );
}
+ /** [EMAIL PROTECTED] */
public void definedTerm_()
{
markup( "</dt>" + EOL );
}
+ /** [EMAIL PROTECTED] */
public void definition()
{
markup( "<dd>" );
@@ -412,36 +487,43 @@
// What follows is at least a paragraph.
}
+ /** [EMAIL PROTECTED] */
public void definition_()
{
markup( "</dd>" + EOL );
}
+ /** [EMAIL PROTECTED] */
public void figure()
{
markup( "<img" );
}
+ /** [EMAIL PROTECTED] */
public void figure_()
{
markup( " />" );
}
- public void figureGraphics(String s)
+ /** [EMAIL PROTECTED] */
+ public void figureGraphics( String s )
{
markup( " src=\"" + s + "\"" );
}
+ /** [EMAIL PROTECTED] */
public void figureCaption()
{
markup( " alt=\"" );
}
+ /** [EMAIL PROTECTED] */
public void figureCaption_()
{
markup( "\"" );
}
+ /** [EMAIL PROTECTED] */
public void paragraph()
{
if ( !itemFlag )
@@ -450,6 +532,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void paragraph_()
{
if ( itemFlag )
@@ -462,6 +545,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void verbatim( boolean boxed )
{
verbatimFlag = true;
@@ -476,6 +560,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void verbatim_()
{
if ( boxedFlag )
@@ -492,21 +577,25 @@
boxedFlag = false;
}
+ /** [EMAIL PROTECTED] */
public void horizontalRule()
{
markup( "<hr />" );
}
+ /** [EMAIL PROTECTED] */
public void table()
{
markup( "<table align=\"center\">" + EOL );
}
+ /** [EMAIL PROTECTED] */
public void table_()
{
markup( "</table>" );
}
+ /** [EMAIL PROTECTED] */
public void tableRows( int[] justification, boolean grid )
{
@@ -514,33 +603,43 @@
this.cellJustif = justification;
}
+ /** [EMAIL PROTECTED] */
public void tableRows_()
{
markup( "</table>" );
}
+ /** [EMAIL PROTECTED] */
public void tableRow()
{
markup( "<tr valign=\"top\">" + EOL );
cellCount = 0;
}
+ /** [EMAIL PROTECTED] */
public void tableRow_()
{
markup( "</tr>" + EOL );
cellCount = 0;
}
+ /** [EMAIL PROTECTED] */
public void tableCell()
{
tableCell( false );
}
+ /** [EMAIL PROTECTED] */
public void tableHeaderCell()
{
tableCell( true );
}
+ /**
+ * Starts a table cell.
+ *
+ * @param headerRow If this cell is part of a header row.
+ */
public void tableCell( boolean headerRow )
{
String justif = null;
@@ -572,32 +671,42 @@
}
}
+ /** [EMAIL PROTECTED] */
public void tableCell_()
{
tableCell_( false );
}
+ /** [EMAIL PROTECTED] */
public void tableHeaderCell_()
{
tableCell_( true );
}
+ /**
+ * Ends a table cell.
+ *
+ * @param headerRow If this cell is part of a header row.
+ */
public void tableCell_( boolean headerRow )
{
markup( "</t" + ( headerRow ? 'h' : 'd' ) + ">" + EOL );
++cellCount;
}
+ /** [EMAIL PROTECTED] */
public void tableCaption()
{
markup( "<p><i>" );
}
+ /** [EMAIL PROTECTED] */
public void tableCaption_()
{
markup( "</i></p>" );
}
+ /** [EMAIL PROTECTED] */
public void anchor( String name )
{
if ( !headFlag && !titleFlag )
@@ -607,6 +716,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void anchor_()
{
if ( !headFlag && !titleFlag )
@@ -615,6 +725,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void link( String name )
{
if ( !headFlag && !titleFlag )
@@ -623,6 +734,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void link_()
{
if ( !headFlag && !titleFlag )
@@ -631,6 +743,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void italic()
{
if ( !headFlag && !titleFlag )
@@ -639,6 +752,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void italic_()
{
if ( !headFlag && !titleFlag )
@@ -647,6 +761,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void bold()
{
if ( !headFlag && !titleFlag )
@@ -655,6 +770,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void bold_()
{
if ( !headFlag && !titleFlag )
@@ -663,6 +779,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void monospaced()
{
if ( !headFlag && !titleFlag )
@@ -671,6 +788,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void monospaced_()
{
if ( !headFlag && !titleFlag )
@@ -679,6 +797,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void lineBreak()
{
if ( headFlag || titleFlag )
@@ -691,6 +810,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void nonBreakingSpace()
{
if ( headFlag || titleFlag )
@@ -703,6 +823,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void text( String text )
{
if ( headFlag )
@@ -723,36 +844,67 @@
//
// ----------------------------------------------------------------------
+ /**
+ * Write text to output, preserving white space.
+ *
+ * @param text The text to write.
+ */
protected void markup( String text )
{
out.write( text, true );
}
+ /**
+ * Write HTML escaped text to output, not preserving white space.
+ *
+ * @param text The text to write.
+ */
protected void content( String text )
{
out.write( escapeHTML( text ), false );
}
+ /**
+ * Write HTML escaped text to output, preserving white space.
+ *
+ * @param text The text to write.
+ */
protected void verbatimContent( String text )
{
out.write( escapeHTML( text ), true );
}
+ /**
+ * Forward to HtmlTools.escapeHTML( text ).
+ *
+ * @param text the String to escape, may be null
+ * @return the text escaped, "" if null String input
+ * @see org.apache.maven.doxia.util.HtmlTools#escapeHTML(String).
+ */
public static String escapeHTML( String text )
{
return HtmlTools.escapeHTML( text );
}
+ /**
+ * Forward to HtmlTools.encodeURL( text ).
+ *
+ * @param text the String to encode, may be null.
+ * @return the text encoded, null if null String input.
+ * @see org.apache.maven.doxia.util.HtmlTools#encodeURL(String).
+ */
public static String encodeURL( String text )
{
return HtmlTools.encodeURL( text );
}
+ /** [EMAIL PROTECTED] */
public void flush()
{
out.flush();
}
+ /** [EMAIL PROTECTED] */
public void close()
{
out.close();
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSiteModule.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSiteModule.java?view=diff&rev=557537&r1=557536&r2=557537
==============================================================================
---
maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSiteModule.java
(original)
+++
maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSiteModule.java
Thu Jul 19 02:42:53 2007
@@ -29,16 +29,19 @@
public class XdocSiteModule
extends AbstractSiteModule
{
+ /** [EMAIL PROTECTED] */
public String getSourceDirectory()
{
return "xdoc";
}
+ /** [EMAIL PROTECTED] */
public String getExtension()
{
return "xml";
}
+ /** [EMAIL PROTECTED] */
public String getParserId()
{
return "xdoc";
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XmlWriterXdocSink.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XmlWriterXdocSink.java?view=diff&rev=557537&r1=557536&r2=557537
==============================================================================
---
maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XmlWriterXdocSink.java
(original)
+++
maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XmlWriterXdocSink.java
Thu Jul 19 02:42:53 2007
@@ -37,26 +37,47 @@
public class XmlWriterXdocSink
extends SinkAdapter
{
+ /** The XMLWriter to write the result. */
private final XMLWriter writer;
+ /** Used to collect text events. */
private StringBuffer buffer = new StringBuffer();
+ /** An indication on if we're inside a head. */
private boolean headFlag;
- //private boolean itemFlag;
+
+ /** An indication on if we're in verbatim mode. */
private boolean verbatimFlag;
+
+ /** Justification of table cells. */
private int[] cellJustif;
+
+ /** Number of cells in a table row. */
private int cellCount;
+
+ /** An indication on if we're inside a item. */
private int itemFlag;
+
+ /** An indication on if we're inside a section title. */
private boolean sectionTitleFlag;
- public XmlWriterXdocSink( XMLWriter writer)
+ /**
+ * Constructor, initialize the XMLWriter.
+ *
+ * @param out The XMLWriter to write the result.
+ */
+ public XmlWriterXdocSink( XMLWriter out )
{
- if(writer == null) {
- throw new IllegalArgumentException("argument can't be null");
+ if ( out == null )
+ {
+ throw new IllegalArgumentException( "Argument can't be null!" );
}
- this.writer = writer;
+ this.writer = out;
}
+ /**
+ * Reset all variables.
+ */
protected void resetState()
{
headFlag = false;
@@ -68,16 +89,18 @@
sectionTitleFlag = false;
}
+ /** [EMAIL PROTECTED] */
public void head()
{
resetState();
headFlag = true;
- writer.startElement("document");
- writer.startElement("properties");
+ writer.startElement( "document" );
+ writer.startElement( "properties" );
}
+ /** [EMAIL PROTECTED] */
public void head_()
{
headFlag = false;
@@ -85,44 +108,49 @@
writer.endElement(); // properties
}
+ /** [EMAIL PROTECTED] */
public void title_()
{
if ( buffer.length() > 0 )
{
- writer.startElement("title");
+ writer.startElement( "title" );
content( buffer.toString() );
writer.endElement(); // title
buffer = new StringBuffer();
}
}
+ /** [EMAIL PROTECTED] */
public void author_()
{
if ( buffer.length() > 0 )
{
- writer.startElement("author");
+ writer.startElement( "author" );
content( buffer.toString() );
writer.endElement(); // author
buffer = new StringBuffer();
}
}
+ /** [EMAIL PROTECTED] */
public void date_()
{
if ( buffer.length() > 0 )
{
- writer.startElement("date");
+ writer.startElement( "date" );
content( buffer.toString() );
writer.endElement();
buffer = new StringBuffer();
}
}
+ /** [EMAIL PROTECTED] */
public void body()
{
- writer.startElement("body");
+ writer.startElement( "body" );
}
+ /** [EMAIL PROTECTED] */
public void body_()
{
writer.endElement(); // body
@@ -132,90 +160,107 @@
resetState();
}
+ /** [EMAIL PROTECTED] */
public void section1()
{
- writer.startElement("section");
+ writer.startElement( "section" );
}
+ /** [EMAIL PROTECTED] */
public void section2()
{
- writer.startElement("subsection");
+ writer.startElement( "subsection" );
}
+ /** [EMAIL PROTECTED] */
public void section3()
{
- writer.startElement("subsection");
+ writer.startElement( "subsection" );
}
+ /** [EMAIL PROTECTED] */
public void section4()
{
- writer.startElement("subsection");
+ writer.startElement( "subsection" );
}
+ /** [EMAIL PROTECTED] */
public void section5()
{
- writer.startElement("subsection");
+ writer.startElement( "subsection" );
}
+ /** [EMAIL PROTECTED] */
public void sectionTitle()
{
sectionTitleFlag = true;
buffer = new StringBuffer();
}
+ /** [EMAIL PROTECTED] */
public void sectionTitle_()
{
sectionTitleFlag = false;
- writer.addAttribute("name", buffer.toString());
+ writer.addAttribute( "name", buffer.toString() );
}
+ /** [EMAIL PROTECTED] */
public void section1_()
{
writer.endElement();
}
+ /** [EMAIL PROTECTED] */
public void section2_()
{
writer.endElement();
}
+ /** [EMAIL PROTECTED] */
public void section3_()
{
writer.endElement();
}
+ /** [EMAIL PROTECTED] */
public void section4_()
{
writer.endElement();
}
+ /** [EMAIL PROTECTED] */
public void section5_()
{
writer.endElement();
}
+ /** [EMAIL PROTECTED] */
public void list()
{
- writer.startElement("ul");
+ writer.startElement( "ul" );
}
+ /** [EMAIL PROTECTED] */
public void list_()
{
writer.endElement();
}
+ /** [EMAIL PROTECTED] */
public void listItem()
{
- writer.startElement("li");
+ writer.startElement( "li" );
itemFlag++;
// What follows is at least a paragraph.
}
+ /** [EMAIL PROTECTED] */
public void listItem_()
{
writer.endElement();
}
+ /** [EMAIL PROTECTED] */
public void numberedList( int numbering )
{
String style;
@@ -237,89 +282,108 @@
default:
style = "decimal";
}
- writer.startElement("ol");
- writer.addAttribute("style", "list-style-type: " + style);
+ writer.startElement( "ol" );
+ writer.addAttribute( "style", "list-style-type: " + style );
}
+ /** [EMAIL PROTECTED] */
public void numberedList_()
{
writer.endElement();
}
+ /** [EMAIL PROTECTED] */
public void numberedListItem()
{
- writer.startElement("li");
+ writer.startElement( "li" );
itemFlag++;
// What follows is at least a paragraph.
}
+ /** [EMAIL PROTECTED] */
public void numberedListItem_()
{
writer.endElement();
}
+ /** [EMAIL PROTECTED] */
public void definitionList()
{
- writer.startElement("dl");
- writer.addAttribute("compact", "compact");
+ writer.startElement( "dl" );
+ writer.addAttribute( "compact", "compact" );
}
+ /** [EMAIL PROTECTED] */
public void definitionList_()
{
writer.endElement();
}
+ /** [EMAIL PROTECTED] */
public void definedTerm()
{
- writer.startElement("dt");
- writer.startElement("b");
+ writer.startElement( "dt" );
+ writer.startElement( "b" );
}
+ /** [EMAIL PROTECTED] */
public void definedTerm_()
{
writer.endElement();
writer.endElement();
}
+ /** [EMAIL PROTECTED] */
public void definition()
{
- writer.startElement("dd");
+ writer.startElement( "dd" );
itemFlag++;
// What follows is at least a paragraph.
}
+ /** [EMAIL PROTECTED] */
public void definition_()
{
writer.endElement();
}
+ /** [EMAIL PROTECTED] */
public void paragraph()
{
if ( itemFlag == 0 )
- writer.startElement("p");
+ {
+ writer.startElement( "p" );
+ }
}
+ /** [EMAIL PROTECTED] */
public void paragraph_()
{
- if ( itemFlag == 0)
+ if ( itemFlag == 0 )
+ {
writer.endElement();
+ }
else
+ {
itemFlag--;
+ }
}
+ /** [EMAIL PROTECTED] */
public void verbatim( boolean boxed )
{
verbatimFlag = true;
if ( boxed )
{
- writer.startElement("source" );
+ writer.startElement( "source" );
}
else
{
- writer.startElement("pre");
+ writer.startElement( "pre" );
}
}
+ /** [EMAIL PROTECTED] */
public void verbatim_()
{
writer.endElement();
@@ -327,60 +391,73 @@
verbatimFlag = false;
}
+ /** [EMAIL PROTECTED] */
public void horizontalRule()
{
- writer.startElement("hr");
+ writer.startElement( "hr" );
writer.endElement();
}
+ /** [EMAIL PROTECTED] */
public void table()
{
- writer.startElement("table");
- writer.addAttribute("align", "center");
+ writer.startElement( "table" );
+ writer.addAttribute( "align", "center" );
}
+ /** [EMAIL PROTECTED] */
public void table_()
{
writer.endElement();
}
+ /** [EMAIL PROTECTED] */
public void tableRows( int[] justification, boolean grid )
-
{
- writer.startElement("table");
- writer.addAttribute("align", "center");
- writer.addAttribute("border", String.valueOf(grid ? 1 : 0) );
+ writer.startElement( "table" );
+ writer.addAttribute( "align", "center" );
+ writer.addAttribute( "border", String.valueOf( grid ? 1 : 0 ) );
this.cellJustif = justification;
}
+ /** [EMAIL PROTECTED] */
public void tableRows_()
{
writer.endElement();
}
+ /** [EMAIL PROTECTED] */
public void tableRow()
{
- writer.startElement("tr");
- writer.addAttribute("valign", "top");
+ writer.startElement( "tr" );
+ writer.addAttribute( "valign", "top" );
cellCount = 0;
}
+ /** [EMAIL PROTECTED] */
public void tableRow_()
{
writer.endElement();
cellCount = 0;
}
+ /** [EMAIL PROTECTED] */
public void tableCell()
{
tableCell( false );
}
+ /** [EMAIL PROTECTED] */
public void tableHeaderCell()
{
tableCell( true );
}
+ /**
+ * Starts a table cell.
+ *
+ * @param headerRow If this cell is part of a header row.
+ */
public void tableCell( boolean headerRow )
{
String justif = null;
@@ -402,107 +479,145 @@
}
}
- writer.startElement("t" + ( headerRow ? 'h' : 'd' ));
+ writer.startElement( "t" + ( headerRow ? 'h' : 'd' ) );
if ( justif != null )
- writer.addAttribute("align", justif);
+ {
+ writer.addAttribute( "align", justif );
+ }
}
+ /** [EMAIL PROTECTED] */
public void tableCell_()
{
tableCell_( false );
}
+ /** [EMAIL PROTECTED] */
public void tableHeaderCell_()
{
tableCell_( true );
}
+ /**
+ * Ends a table cell.
+ *
+ * @param headerRow If this cell is part of a header row.
+ */
public void tableCell_( boolean headerRow )
{
writer.endElement();
++cellCount;
}
+ /** [EMAIL PROTECTED] */
public void tableCaption()
{
- writer.startElement("p");
- writer.startElement("i");
+ writer.startElement( "p" );
+ writer.startElement( "i" );
}
+ /** [EMAIL PROTECTED] */
public void tableCaption_()
{
writer.endElement();
writer.endElement();
}
+ /** [EMAIL PROTECTED] */
public void anchor( String name )
{
if ( !headFlag )
{
String id = StructureSink.linkToKey( name );
- writer.startElement("a");
- writer.addAttribute("id", id);
- writer.addAttribute("name", id);
+ writer.startElement( "a" );
+ writer.addAttribute( "id", id );
+ writer.addAttribute( "name", id );
}
}
+ /** [EMAIL PROTECTED] */
public void anchor_()
{
if ( !headFlag )
+ {
writer.endElement();
+ }
}
+ /** [EMAIL PROTECTED] */
public void link( String name )
{
if ( !headFlag )
{
- writer.startElement("a");
- writer.addAttribute("href", name);
+ writer.startElement( "a" );
+ writer.addAttribute( "href", name );
}
}
+ /** [EMAIL PROTECTED] */
public void link_()
{
if ( !headFlag )
+ {
writer.endElement();
+ }
}
+ /** [EMAIL PROTECTED] */
public void italic()
{
if ( !headFlag )
- writer.startElement("i");
+ {
+ writer.startElement( "i" );
+ }
}
+ /** [EMAIL PROTECTED] */
public void italic_()
{
if ( !headFlag )
+ {
writer.endElement();
+ }
}
+ /** [EMAIL PROTECTED] */
public void bold()
{
if ( !headFlag )
- writer.startElement("b");
+ {
+ writer.startElement( "b" );
+ }
}
+ /** [EMAIL PROTECTED] */
public void bold_()
{
if ( !headFlag )
+ {
writer.endElement();
+ }
}
+ /** [EMAIL PROTECTED] */
public void monospaced()
{
if ( !headFlag )
- writer.startElement("tt");
+ {
+ writer.startElement( "tt" );
+ }
}
+ /** [EMAIL PROTECTED] */
public void monospaced_()
{
if ( !headFlag )
+ {
writer.endElement();
+ }
}
+ /** [EMAIL PROTECTED] */
public void lineBreak()
{
if ( headFlag )
@@ -511,11 +626,12 @@
}
else
{
- writer.startElement("br");
+ writer.startElement( "br" );
writer.endElement();
}
}
+ /** [EMAIL PROTECTED] */
public void nonBreakingSpace()
{
if ( headFlag )
@@ -528,6 +644,7 @@
}
}
+ /** [EMAIL PROTECTED] */
public void text( String text )
{
if ( headFlag )
@@ -556,30 +673,56 @@
// ----------------------------------------------------------------------
+ /**
+ * Write HTML escaped text to output.
+ *
+ * @param text The text to write.
+ */
protected void content( String text )
{
- writer.writeText(escapeHTML( text ));
+ writer.writeText( escapeHTML( text ) );
}
+ /**
+ * Write text to output, preserving white space.
+ *
+ * @param text The text to write.
+ */
protected void verbatimContent( String text )
{
writer.writeText( StringUtil.replaceAll( text, " ", " " ) );
}
+ /**
+ * Forward to HtmlTools.escapeHTML( text ).
+ *
+ * @param text the String to escape, may be null
+ * @return the text escaped, "" if null String input
+ * @see org.apache.maven.doxia.util.HtmlTools#escapeHTML(String).
+ */
public static String escapeHTML( String text )
{
return HtmlTools.escapeHTML( text );
}
+ /**
+ * Forward to HtmlTools.encodeURL( text ).
+ *
+ * @param text the String to encode, may be null.
+ * @return the text encoded, null if null String input.
+ * @see org.apache.maven.doxia.util.HtmlTools#encodeURL(String).
+ */
public static String encodeURL( String text )
{
return HtmlTools.encodeURL( text );
}
+ /** [EMAIL PROTECTED] */
public void flush()
{
}
+ /** [EMAIL PROTECTED] */
public void close()
{
}
