[DOXIASITETOOLS-236] Deprecate Doxia Sitetools Doc Renderer

michael-o · michael-o · commit cabe7d304f9e · 2021-11-28T19:53:05.000+01:00
diff --git a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.java b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.java
@@ -69,6 +69,7 @@
  * @author ltheussl
  * @since 1.1
  */
+@Deprecated
 public abstract class AbstractDocumentRenderer
     extends AbstractLogEnabled
     implements DocumentRenderer
diff --git a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocRenderer.java b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocRenderer.java
@@ -28,6 +28,7 @@
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
  * @deprecated Since 1.1, use {@link DocumentRenderer} instead.
  */
+@Deprecated
 public interface DocRenderer
 {
     /** Plexus lookup. */
diff --git a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRenderer.java b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRenderer.java
@@ -32,6 +32,7 @@
  * @author ltheussl
  * @since 1.1
  */
+@Deprecated
 public interface DocumentRenderer
 {
     /** Plexus lookup role. */
diff --git a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRendererContext.java b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRendererContext.java
@@ -30,6 +30,7 @@
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
  * @since 1.1.2
  */
+@Deprecated
 public class DocumentRendererContext
 {
     private String inputEncoding = ReaderFactory.UTF_8;
diff --git a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRendererException.java b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRendererException.java
@@ -25,6 +25,7 @@
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
  * @since 1.1
  */
+@Deprecated
 public class DocumentRendererException
     extends Exception
 {
diff --git a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.java b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.java
@@ -34,6 +34,7 @@
  * @author ltheussl
  * @since 1.1
  */
+@Deprecated
 public abstract class AbstractPdfRenderer
     extends AbstractDocumentRenderer
     implements PdfRenderer
diff --git a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.java b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.java
@@ -30,6 +30,7 @@
  * @author ltheussl
  * @since 1.1
  */
+@Deprecated
 public interface PdfRenderer
     extends DocumentRenderer
 {
diff --git a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/fo/FoPdfRenderer.java b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/fo/FoPdfRenderer.java
@@ -55,6 +55,7 @@
  * @author ltheussl
  * @since 1.1
  */
+@Deprecated
 @Component( role = PdfRenderer.class, hint = "fo" )
 public class FoPdfRenderer
     extends AbstractPdfRenderer
@@ -300,7 +301,7 @@ private void renderModules( String href, FoAggregateSink sink, DocumentTOCItem t
                 {
                     String doc = href + "." + extension;
                     File source = new File( moduleBasedir, doc );
-    
+
                     // Velocity file?
                     if ( !source.exists() )
                     {
@@ -314,12 +315,12 @@ private void renderModules( String href, FoAggregateSink sink, DocumentTOCItem t
                         }
                         source = new File( moduleBasedir, doc );
                     }
-    
+
                     if ( source.exists() )
                     {
                         sink.setDocumentName( doc );
                         sink.setDocumentTitle( tocItem.getName() );
-    
+
                         parse( source.getPath(), module.getParserId(), sink, context );
                     }
                 }
diff --git a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/itext/ITextPdfRenderer.java b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/itext/ITextPdfRenderer.java
@@ -79,6 +79,7 @@
  * @author ltheussl
  * @since 1.1
  */
+@Deprecated
 @Component( role = PdfRenderer.class, hint = "itext" )
 public class ITextPdfRenderer
     extends AbstractPdfRenderer
@@ -611,7 +612,7 @@ private List<File> parseTOCFiles( File outputDirectory, DocumentModel documentMo
                     {
                         String doc = href + "." + extension;
                         File source = new File( moduleBasedir, doc );
-    
+
                         // Velocity file?
                         if ( !source.exists() )
                         {
@@ -625,7 +626,7 @@ private List<File> parseTOCFiles( File outputDirectory, DocumentModel documentMo
                             }
                             source = new File( moduleBasedir, doc );
                         }
-    
+
                         if ( source.exists() )
                         {
                             String outputITextName = doc.substring( 0, doc.lastIndexOf( '.' ) + 1 ) + "xml";
@@ -635,7 +636,7 @@ private List<File> parseTOCFiles( File outputDirectory, DocumentModel documentMo
                             {
                                 outputITextFileTmp.getParentFile().mkdirs();
                             }
-    
+
                             iTextFiles.add( outputITextFileTmp );
                             parse( source, module, outputITextFileTmp, context );
                         }
diff --git a/doxia-doc-renderer/src/site/apt/index.apt b/doxia-doc-renderer/src/site/apt/index.apt
@@ -0,0 +1,27 @@
+ --------------
+ Maven Doxia Sitetools Doc Renderer
+ --------------
+
+ ~~ 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.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Deprecation Notice
+
+  This Doxia Sitetools module is deprecated and will be removed in version 2.0.0.

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@`
`28`	`28`	`* @author <a href="mailto:[email protected]">Vincent Siveton</a>`
`29`	`29`	`* @deprecated Since 1.1, use {@link DocumentRenderer} instead.`
`30`	`30`	`*/`
	`31`	`+@Deprecated`
`31`	`32`	`public interface DocRenderer`
`32`	`33`	`{`
`33`	`34`	`/** Plexus lookup. */`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@`
`32`	`32`	`* @author ltheussl`
`33`	`33`	`* @since 1.1`
`34`	`34`	`*/`
	`35`	`+@Deprecated`
`35`	`36`	`public interface DocumentRenderer`
`36`	`37`	`{`
`37`	`38`	`/** Plexus lookup role. */`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@`
`30`	`30`	`* @author <a href="mailto:[email protected]">Vincent Siveton</a>`
`31`	`31`	`* @since 1.1.2`
`32`	`32`	`*/`
	`33`	`+@Deprecated`
`33`	`34`	`public class DocumentRendererContext`
`34`	`35`	`{`
`35`	`36`	`private String inputEncoding = ReaderFactory.UTF_8;`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@`
`25`	`25`	`* @author <a href="mailto:[email protected]">Vincent Siveton</a>`
`26`	`26`	`* @since 1.1`
`27`	`27`	`*/`
	`28`	`+@Deprecated`
`28`	`29`	`public class DocumentRendererException`
`29`	`30`	`extends Exception`
`30`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@`
`55`	`55`	`* @author ltheussl`
`56`	`56`	`* @since 1.1`
`57`	`57`	`*/`
	`58`	`+@Deprecated`
`58`	`59`	`@Component( role = PdfRenderer.class, hint = "fo" )`
`59`	`60`	`public class FoPdfRenderer`
`60`	`61`	`extends AbstractPdfRenderer`
`@@ -300,7 +301,7 @@ private void renderModules( String href, FoAggregateSink sink, DocumentTOCItem t`
`300`	`301`	`{`
`301`	`302`	`String doc = href + "." + extension;`
`302`	`303`	`File source = new File( moduleBasedir, doc );`
`303`		`-`
	`304`	`+`
`304`	`305`	`// Velocity file?`
`305`	`306`	`if ( !source.exists() )`
`306`	`307`	`{`
`@@ -314,12 +315,12 @@ private void renderModules( String href, FoAggregateSink sink, DocumentTOCItem t`
`314`	`315`	`}`
`315`	`316`	`source = new File( moduleBasedir, doc );`
`316`	`317`	`}`
`317`		`-`
	`318`	`+`
`318`	`319`	`if ( source.exists() )`
`319`	`320`	`{`
`320`	`321`	`sink.setDocumentName( doc );`
`321`	`322`	`sink.setDocumentTitle( tocItem.getName() );`
`322`		`-`
	`323`	`+`
`323`	`324`	`parse( source.getPath(), module.getParserId(), sink, context );`
`324`	`325`	`}`
`325`	`326`	`}`
Original file line number	Diff line number	Diff line change
`@@ -79,6 +79,7 @@`
`79`	`79`	`* @author ltheussl`
`80`	`80`	`* @since 1.1`
`81`	`81`	`*/`
	`82`	`+@Deprecated`
`82`	`83`	`@Component( role = PdfRenderer.class, hint = "itext" )`
`83`	`84`	`public class ITextPdfRenderer`
`84`	`85`	`extends AbstractPdfRenderer`
`@@ -611,7 +612,7 @@ private List<File> parseTOCFiles( File outputDirectory, DocumentModel documentMo`
`611`	`612`	`{`
`612`	`613`	`String doc = href + "." + extension;`
`613`	`614`	`File source = new File( moduleBasedir, doc );`
`614`		`-`
	`615`	`+`
`615`	`616`	`// Velocity file?`
`616`	`617`	`if ( !source.exists() )`
`617`	`618`	`{`
`@@ -625,7 +626,7 @@ private List<File> parseTOCFiles( File outputDirectory, DocumentModel documentMo`
`625`	`626`	`}`
`626`	`627`	`source = new File( moduleBasedir, doc );`
`627`	`628`	`}`
`628`		`-`
	`629`	`+`
`629`	`630`	`if ( source.exists() )`
`630`	`631`	`{`
`631`	`632`	`String outputITextName = doc.substring( 0, doc.lastIndexOf( '.' ) + 1 ) + "xml";`
`@@ -635,7 +636,7 @@ private List<File> parseTOCFiles( File outputDirectory, DocumentModel documentMo`
`635`	`636`	`{`
`636`	`637`	`outputITextFileTmp.getParentFile().mkdirs();`
`637`	`638`	`}`
`638`		`-`
	`639`	`+`
`639`	`640`	`iTextFiles.add( outputITextFileTmp );`
`640`	`641`	`parse( source, module, outputITextFileTmp, context );`
`641`	`642`	`}`