Author: vsiveton Date: Fri Feb 15 05:23:43 2008 New Revision: 628060 URL: http://svn.apache.org/viewvc?rev=628060&view=rev Log: o updated javadoc
Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java?rev=628060&r1=628059&r2=628060&view=diff ============================================================================== --- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java (original) +++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java Fri Feb 15 05:23:43 2008 @@ -32,6 +32,8 @@ import javax.swing.text.html.HTML.Tag; /** + * Sink for site renderering. + * * @author <a href="mailto:[EMAIL PROTECTED]>Emmanuel Venisse</a> * @version $Id$ */ @@ -47,11 +49,18 @@ private final Writer writer; + /** + * @param renderingContext + */ public SiteRendererSink( RenderingContext renderingContext ) { this( new StringWriter(), renderingContext ); } + /** + * @param writer + * @param renderingContext + */ private SiteRendererSink( StringWriter writer, RenderingContext renderingContext ) { super( writer, renderingContext, null ); @@ -59,9 +68,7 @@ this.writer = writer; } - /** - * @see org.apache.maven.doxia.module.xhtml.XhtmlSink#title_() - */ + /** [EMAIL PROTECTED] */ public void title_() { if ( getBuffer().length() > 0 ) @@ -73,10 +80,13 @@ } /** + * Do nothing. + * * @see org.apache.maven.doxia.module.xhtml.XhtmlSink#title() */ public void title() { + // nop } public String getTitle() @@ -84,9 +94,7 @@ return title; } - /** - * @see org.apache.maven.doxia.module.xhtml.XhtmlSink#author_() - */ + /** [EMAIL PROTECTED] */ public void author_() { if ( getBuffer().length() > 0 ) @@ -102,9 +110,7 @@ return authors; } - /** - * @see org.apache.maven.doxia.module.xhtml.XhtmlSink#date_() - */ + /** [EMAIL PROTECTED] */ public void date_() { if ( getBuffer().length() > 0 ) @@ -121,17 +127,23 @@ } /** + * Do nothing. + * * @see org.apache.maven.doxia.module.xhtml.XhtmlSink#body_() */ public void body_() { + // nop } /** + * Do nothing. + * * @see org.apache.maven.doxia.module.xhtml.XhtmlSink#body() */ public void body() { + // nop } public String getBody() @@ -139,17 +151,13 @@ return writer.toString(); } - /** - * @see org.apache.maven.doxia.module.xhtml.XhtmlSink#head_() - */ + /** [EMAIL PROTECTED] */ public void head_() { setHeadFlag( false ); } - /** - * @see org.apache.maven.doxia.module.xhtml.XhtmlSink#head() - */ + /** [EMAIL PROTECTED] */ public void head() { setHeadFlag( true ); @@ -157,6 +165,8 @@ /** * Sets the head flag to true so the title text is buffered until the closing tag. + * + * @see org.apache.maven.doxia.sink.XhtmlBaseSink#sectionTitle1() */ public void sectionTitle1() { @@ -166,6 +176,8 @@ /** * Writes out a sectionTitle1 block, including an anchor that is constructed from the * buffered title text via [EMAIL PROTECTED] org.apache.maven.doxia.util.HtmlTools#encodeId(String)}. + * + * @see org.apache.maven.doxia.sink.XhtmlBaseSink#sectionTitle1_() */ public void sectionTitle1_() { @@ -189,6 +201,8 @@ /** * Sets the head flag to true so the title text is buffered until the closing tag. + * + * @see org.apache.maven.doxia.sink.XhtmlBaseSink#sectionTitle2() */ public void sectionTitle2() { @@ -198,6 +212,8 @@ /** * Writes out a sectionTitle2 block, including an anchor that is constructed from the * buffered title text via [EMAIL PROTECTED] org.apache.maven.doxia.util.HtmlTools#encodeId(String)}. + * + * @see org.apache.maven.doxia.sink.XhtmlBaseSink#sectionTitle2_() */ public void sectionTitle2_() { @@ -218,5 +234,4 @@ text( sectionTitle ); writeEndTag( Tag.H3 ); } - }