Re: svn commit: r1293991 - /maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java

2012-02-27 Thread Lukas Theussl 


Salut Herve,

Just a comment: my IDE (netbeans) now shows a javadoc error because the 
{@inheritDoc} doesn't pick up the description of the corresponding 
parameter. Could the parameter name be changed in the interface as well?


-Lukas


hbout...@apache.org wrote:

Author: hboutemy
Date: Mon Feb 27 01:34:11 2012
New Revision: 1293991

URL: http://svn.apache.org/viewvc?rev=1293991view=rev
Log:
renamed parameter for better understanding

Modified:
 
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java

Modified: 
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
URL: 
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java?rev=1293991r1=1293990r2=1293991view=diff
==
--- 
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
 (original)
+++ 
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
 Mon Feb 27 01:34:11 2012
@@ -334,7 +334,7 @@ public class DefaultSiteRenderer
  }

  /** {@inheritDoc} */
-public void renderDocument( Writer writer, RenderingContext 
renderingContext, SiteRenderingContext context )
+public void renderDocument( Writer writer, RenderingContext 
renderingContext, SiteRenderingContext siteContext )
  throws RendererException, FileNotFoundException, 
UnsupportedEncodingException
  {
  SiteRendererSink sink = new SiteRendererSink( renderingContext );
@@ -355,14 +355,14 @@ public class DefaultSiteRenderer
  {
  SiteResourceLoader.setResource( resource );

-Context vc = createVelocityContext( sink, context );
+Context vc = createVelocityContext( sink, siteContext );

  StringWriter sw = new StringWriter();

-velocity.getEngine().mergeTemplate( resource, 
context.getInputEncoding(), vc, sw );
+velocity.getEngine().mergeTemplate( resource, 
siteContext.getInputEncoding(), vc, sw );

  reader = new StringReader( sw.toString() );
-if ( parser.getType() == Parser.XML_TYPE  
context.isValidate() )
+if ( parser.getType() == Parser.XML_TYPE  
siteContext.isValidate() )
  {
  reader = validate( reader, resource );
  }
@@ -385,7 +385,7 @@ public class DefaultSiteRenderer
  {
  case Parser.XML_TYPE:
  reader = ReaderFactory.newXmlReader( doc );
-if ( context.isValidate() )
+if ( siteContext.isValidate() )
  {
  reader = validate( reader, resource );
  }
@@ -394,7 +394,7 @@ public class DefaultSiteRenderer
  case Parser.TXT_TYPE:
  case Parser.UNKNOWN_TYPE:
  default:
-reader = ReaderFactory.newReader( doc, 
context.getInputEncoding() );
+reader = ReaderFactory.newReader( doc, 
siteContext.getInputEncoding() );
  }
  }
  sink.enableLogging( new PlexusLoggerWrapper( getLogger() ) );
@@ -422,7 +422,7 @@ public class DefaultSiteRenderer
  IOUtil.close( reader );
  }

-generateDocument( writer, sink, context );
+generateDocument( writer, sink, siteContext );
  }

  private Context createVelocityContext( SiteRendererSink sink, 
SiteRenderingContext siteRenderingContext )




-
To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org
For additional commands, e-mail: dev-h...@maven.apache.org

Re: svn commit: r1293991 - /maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java

2012-02-27 Thread Hervé BOUTEMY 
done
thanks for the report

Hervé

Le lundi 27 février 2012 09:33:11 Lukas Theussl a écrit :
 Salut Herve,
 
 Just a comment: my IDE (netbeans) now shows a javadoc error because the
 {@inheritDoc} doesn't pick up the description of the corresponding
 parameter. Could the parameter name be changed in the interface as well?
 
 -Lukas
 
 hbout...@apache.org wrote:
  Author: hboutemy
  Date: Mon Feb 27 01:34:11 2012
  New Revision: 1293991
  
  URL: http://svn.apache.org/viewvc?rev=1293991view=rev
  Log:
  renamed parameter for better understanding
  
  Modified:
   maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main
   /java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.
   java 
  Modified:
  maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org
  /apache/maven/doxia/siterenderer/DefaultSiteRenderer.java URL:
  http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-si
  te-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSit
  eRenderer.java?rev=1293991r1=1293990r2=1293991view=diff
  ===
  === ---
  maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org
  /apache/maven/doxia/siterenderer/DefaultSiteRenderer.java (original) +++
  maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org
  /apache/maven/doxia/siterenderer/DefaultSiteRenderer.java Mon Feb 27
  01:34:11 2012 @@ -334,7 +334,7 @@ public class DefaultSiteRenderer
  
}

/** {@inheritDoc} */
  
  -public void renderDocument( Writer writer, RenderingContext
  renderingContext, SiteRenderingContext context ) +public void
  renderDocument( Writer writer, RenderingContext renderingContext,
  SiteRenderingContext siteContext ) 
throws RendererException,
FileNotFoundException,
UnsupportedEncodingException   
{

SiteRendererSink sink = new SiteRendererSink(
renderingContext ); 
  @@ -355,14 +355,14 @@ public class DefaultSiteRenderer
  
{

SiteResourceLoader.setResour
ce( resource );
  
  -Context vc = createVelocityContext( sink, context
  );
  +Context vc = createVelocityContext( sink,
  siteContext ); 
StringWriter sw = new
StringWriter();
  
  -velocity.getEngine().mergeTemplate( resource,
  context.getInputEncoding(), vc, sw ); +   
  velocity.getEngine().mergeTemplate( resource,
  siteContext.getInputEncoding(), vc, sw ); 
reader = new StringReader(
sw.toString() );
  
  -if ( parser.getType() == Parser.XML_TYPE 
  context.isValidate() ) +if ( parser.getType() ==
  Parser.XML_TYPE  siteContext.isValidate() ) 
{

reader = validate(
reader, resource );

}
  
  @@ -385,7 +385,7 @@ public class DefaultSiteRenderer
  
{

case Parser.XML_TYPE:
reader =
ReaderFactory.newXm
lReader( doc );
  
  -if ( context.isValidate() )
  +if ( siteContext.isValidate() )
  
{

reader =
validate(
reader,
resource );

}
  
  @@ -394,7 +394,7 @@ public class DefaultSiteRenderer
  
case Parser.TXT_TYPE:
case Parser.UNKNOWN_TYPE:
  
default:
  -reader = ReaderFactory.newReader( doc,
  context.getInputEncoding() ); +reader =
  ReaderFactory.newReader( doc, siteContext.getInputEncoding() ); 
}

}
sink.enableLogging( new PlexusLoggerWrapper(
getLogger() ) ); 
  @@ -422,7 +422,7 @@ public class DefaultSiteRenderer
  
IOUtil.close( reader );

}
  
  -generateDocument( writer, sink, context );
  +generateDocument( writer, sink, siteContext );
  
}

private Context createVelocityContext( SiteRendererSink
sink, SiteRenderingContext siteRenderingContext )
 -
 To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org
 For additional commands, e-mail: