You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2016/01/23 16:49:38 UTC
svn commit: r1726408 - in
/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src:
main/java/org/apache/maven/doxia/siterenderer/
test/java/org/apache/maven/doxia/siterenderer/ test/resources/site/apt/
test/resources/site/xdoc/
Author: hboutemy
Date: Sat Jan 23 15:49:38 2016
New Revision: 1726408
URL: http://svn.apache.org/viewvc?rev=1726408&view=rev
Log:
[DOXIASITETOOLS-146] don't render source markup comments in site's output HTML
Added:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/CommentsVerifier.java (with props)
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/resources/site/apt/apt.apt
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/resources/site/xdoc/misc.xml
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=1726408&r1=1726407&r2=1726408&view=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 Sat Jan 23 15:49:38 2016
@@ -329,6 +329,8 @@ public class DefaultSiteRenderer
String resource = doc.getAbsolutePath();
Parser parser = doxia.getParser( renderingContext.getParserId() );
+ // DOXIASITETOOLS-146 don't render comments from source markup
+ parser.setEmitComments( false );
// TODO: DOXIA-111: the filter used here must be checked generally.
if ( renderingContext.getAttribute( "velocity" ) != null )
Added: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/CommentsVerifier.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/CommentsVerifier.java?rev=1726408&view=auto
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/CommentsVerifier.java (added)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/CommentsVerifier.java Sat Jan 23 15:49:38 2016
@@ -0,0 +1,41 @@
+package org.apache.maven.doxia.siterenderer;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import java.io.File;
+
+import org.codehaus.plexus.util.FileUtils;
+
+/**
+ * Verifies that there are no DOXIASITETOOLS-146 comments
+ */
+public class CommentsVerifier
+ extends AbstractVerifier
+{
+ /** {@inheritDoc} */
+ public void verify( String file )
+ throws Exception
+ {
+ String content = FileUtils.fileRead( new File( file ), "UTF-8" );
+
+ assertTrue( file + " should not contain 'DOXIASITETOOLS-146' text in comments",
+ content.indexOf( "DOXIASITETOOLS-146" ) < 0 );
+ }
+}
Propchange: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/CommentsVerifier.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/CommentsVerifier.java
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/CommentsVerifier.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java?rev=1726408&r1=1726407&r2=1726408&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java Sat Jan 23 15:49:38 2016
@@ -380,7 +380,10 @@ public class DefaultSiteRendererTest
public void verifyMisc()
throws Exception
{
- MiscVerifier verifier = new MiscVerifier();
+ AbstractVerifier verifier = new MiscVerifier();
+ verifier.verify( "target/output/misc.html" );
+
+ verifier = new CommentsVerifier();
verifier.verify( "target/output/misc.html" );
}
@@ -401,7 +404,10 @@ public class DefaultSiteRendererTest
public void verifyApt()
throws Exception
{
- AptVerifier verifier = new AptVerifier();
+ AbstractVerifier verifier = new AptVerifier();
+ verifier.verify( "target/output/apt.html" );
+
+ verifier = new CommentsVerifier();
verifier.verify( "target/output/apt.html" );
}
Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/resources/site/apt/apt.apt
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/resources/site/apt/apt.apt?rev=1726408&r1=1726407&r2=1726408&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/resources/site/apt/apt.apt (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/resources/site/apt/apt.apt Sat Jan 23 15:49:38 2016
@@ -46,6 +46,8 @@ Section formatting: <italic> <<bold>> <<
{No Default Anchor in Section Title with Explicit Anchor}
+~~ DOXIASITETOOLS-146 comments are not rendered
+
TOC Macro
%{toc}
Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/resources/site/xdoc/misc.xml
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/resources/site/xdoc/misc.xml?rev=1726408&r1=1726407&r2=1726408&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/resources/site/xdoc/misc.xml (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/test/resources/site/xdoc/misc.xml Sat Jan 23 15:49:38 2016
@@ -27,5 +27,7 @@
<param name="midlet" value="org.micro.applet.SimpleDemoMIDlet"/>
</applet>
+ <!-- DOXIASITETOOLS-146 comments are not rendered -->
+
</body>
</document>