0.3.8.2 (2022-02-10)

+ Added no comments configuration for Markdown handlers
fugerit-org · Feb 10, 2022 · 3a13e95 · 3a13e95
1 parent 41b3dd1
commit 3a13e95
Show file tree

Hide file tree

Showing 17 changed files with 79 additions and 24 deletions.
diff --git a/docgen/parameters.json b/docgen/parameters.json
@@ -1,8 +1,8 @@
 {
 	"title" : "Venus (Fugerit Document Generation Framework)",
 	"name": "Venus",
-	"version" : "0.3.8.1",
-	"date" : "09/02/2022",
+	"version" : "0.3.8.2",
+	"date" : "10/02/2022",
 	"organization" : {
 		"name" : "Fugerit Org",
 		"url" : "https://www.fugerit.org"

diff --git a/docgen/release-notes.txt b/docgen/release-notes.txt
@@ -1,4 +1,8 @@
-0.3.8.1 (2022-02-09)
+0.3.8.2 (2022-02-10)
+--------------------
++ Added no comments configuration for Markdown handlers
+
+0.3.8.1 (2022-02-09)
 --------------------
 + Added constant for type markdown (md)
 

diff --git a/fj-doc-base/pom.xml b/fj-doc-base/pom.xml
@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>org.fugerit.java</groupId>
 		<artifactId>fj-doc</artifactId>
-		<version>0.3.8.1</version>
+		<version>0.3.8.2</version>
 	</parent>
 
 	<name>fj-doc-base</name>

diff --git a/...ava/org/fugerit/java/doc/base/typehandler/markdown/AbstractCustomMarkdownTypeHandler.java b/...ava/org/fugerit/java/doc/base/typehandler/markdown/AbstractCustomMarkdownTypeHandler.java
@@ -11,13 +11,24 @@ public abstract class AbstractCustomMarkdownTypeHandler extends DocTypeHandlerDe
 
 	public static final String MIME = "text/x-markdown";
 
-	public AbstractCustomMarkdownTypeHandler() {
+	public AbstractCustomMarkdownTypeHandler( boolean printComments ) {
 		super(TYPE, MODULE, MIME);
+		this.printComments = printComments;
+	}
+
+	public AbstractCustomMarkdownTypeHandler() {
+		this( MarkdownBasicDocFacade.DEFAULT_PRINT_COMMENTS );
 	}
 
 	/**
 	 * 
 	 */
 	private static final long serialVersionUID = -739451608L;
 
+	private boolean printComments;
+
+	public boolean isPrintComments() {
+		return printComments;
+	}
+
 }
diff --git a/.../src/main/java/org/fugerit/java/doc/base/typehandler/markdown/MarkdownBasicDocFacade.java b/.../src/main/java/org/fugerit/java/doc/base/typehandler/markdown/MarkdownBasicDocFacade.java
@@ -41,25 +41,36 @@ public class MarkdownBasicDocFacade extends DocTypeFacadeDefault {
 
 	private PrintWriter writer;
 
+	private boolean printComments;
+
+	public static final boolean DEFAULT_PRINT_COMMENTS = true;
+
 	protected PrintWriter getWriter() {
 		return writer;
 	}
 
 	public MarkdownBasicDocFacade(PrintWriter writer) {
+		this( writer, DEFAULT_PRINT_COMMENTS );
+	}
+
+	public MarkdownBasicDocFacade(PrintWriter writer, boolean printComments) {
 		super();
 		this.writer = writer;
+		this.printComments = printComments;
 	}
 
 	@Override
 	public void handleDoc(DocBase docBase) throws Exception {
-		// just comment to the generated output :
-		this.getWriter().print( "[//]: # (generator : " );
-		this.getWriter().print( this.getClass().getName() );
-		this.getWriter().println( " )" );
-		this.getWriter().print( "[//]: # (generated on " );
-		this.getWriter().print( new Date() );
-		this.getWriter().println( " )  " );
-		this.getWriter().println();
+		if ( this.printComments ) {
+			// just comment to the generated output :
+			this.getWriter().print( "[//]: # (generator : " );
+			this.getWriter().print( this.getClass().getName() );
+			this.getWriter().println( " )" );
+			this.getWriter().print( "[//]: # (generated on " );
+			this.getWriter().print( new Date() );
+			this.getWriter().println( " )  " );
+			this.getWriter().println();			
+		}
 		// actual document handling :we will treat only the body
 		DocTypeFacadeHelper helper = new DocTypeFacadeHelper( docBase );
 		this.handleElements( docBase.getDocBody(), helper );

diff --git a/...se/src/main/java/org/fugerit/java/doc/base/typehandler/markdown/MarkdownExtDocFacade.java b/...se/src/main/java/org/fugerit/java/doc/base/typehandler/markdown/MarkdownExtDocFacade.java
@@ -33,6 +33,10 @@ public MarkdownExtDocFacade(PrintWriter writer) {
 		super(writer);
 	}
 
+	public MarkdownExtDocFacade(PrintWriter writer, boolean printComments) {
+		super(writer, printComments);
+	}
+
 	@Override
 	public void handleTable(DocTable docTable, DocContainer parent, DocTypeFacadeHelper helper) throws Exception {
 		this.getWriter().println();

diff --git a/...n/java/org/fugerit/java/doc/base/typehandler/markdown/SimpleMarkdownBasicTypeHandler.java b/...n/java/org/fugerit/java/doc/base/typehandler/markdown/SimpleMarkdownBasicTypeHandler.java
@@ -22,11 +22,25 @@ public class SimpleMarkdownBasicTypeHandler extends AbstractCustomMarkdownTypeHa
 
 	public static final DocTypeHandler HANDLER = new SimpleMarkdownBasicTypeHandler();
 
+	public static final DocTypeHandler HANDLER_NOCOMMENTS = new SimpleMarkdownBasicTypeHandler( false );
+
 	/**
 	 * 
 	 */
 	private static final long serialVersionUID = -73945133608L;
 
+
+
+	public SimpleMarkdownBasicTypeHandler() {
+		super();
+	}
+
+
+
+	public SimpleMarkdownBasicTypeHandler(boolean printComments) {
+		super(printComments);
+	}
+
 	@Override
 	public void handle(DocInput docInput, DocOutput docOutput) throws Exception {
 		PrintWriter writer = new PrintWriter( new OutputStreamWriter( docOutput.getOs() ) );
@@ -36,7 +50,7 @@ public void handle(DocInput docInput, DocOutput docOutput) throws Exception {
 		 * the DocBase model in the desired output (DocPara, DocTable, DocList etc).
 		 * Here we created a facade to do so : 
 		 */
-		MarkdownBasicDocFacade facade = new MarkdownBasicDocFacade( writer );
+		MarkdownBasicDocFacade facade = new MarkdownBasicDocFacade( writer, this.isPrintComments() );
 		facade.handleDoc( docBase );
 	}
 

diff --git a/...ain/java/org/fugerit/java/doc/base/typehandler/markdown/SimpleMarkdownExtTypeHandler.java b/...ain/java/org/fugerit/java/doc/base/typehandler/markdown/SimpleMarkdownExtTypeHandler.java
@@ -22,11 +22,22 @@ public class SimpleMarkdownExtTypeHandler extends AbstractCustomMarkdownTypeHand
 
 	public static final DocTypeHandler HANDLER = new SimpleMarkdownExtTypeHandler();
 
+	public static final DocTypeHandler HANDLER_NOCOMMENTS = new SimpleMarkdownExtTypeHandler( false );
+
 	/**
 	 * 
 	 */
 	private static final long serialVersionUID = -7394541608L;
 
+	public SimpleMarkdownExtTypeHandler() {
+		super();
+	}
+
+	public SimpleMarkdownExtTypeHandler(boolean printComments) {
+		super(printComments);
+		// TODO Auto-generated constructor stub
+	}
+
 	@Override
 	public void handle(DocInput docInput, DocOutput docOutput) throws Exception {
 		PrintWriter writer = new PrintWriter( new OutputStreamWriter( docOutput.getOs() ) );
@@ -36,7 +47,7 @@ public void handle(DocInput docInput, DocOutput docOutput) throws Exception {
 		 * the DocBase model in the desired output (DocPara, DocTable, DocList etc).
 		 * Here we created a facade to do so : 
 		 */
-		MarkdownExtDocFacade facade = new MarkdownExtDocFacade( writer );
+		MarkdownExtDocFacade facade = new MarkdownExtDocFacade( writer, this.isPrintComments() );
 		facade.handleDoc( docBase );
 	}
 

diff --git a/fj-doc-ent/pom.xml b/fj-doc-ent/pom.xml
@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>org.fugerit.java</groupId>
 		<artifactId>fj-doc</artifactId>
-		<version>0.3.8.1</version>
+		<version>0.3.8.2</version>
 	</parent>
 
 	<name>fj-doc-ent</name>

diff --git a/fj-doc-freemarker/pom.xml b/fj-doc-freemarker/pom.xml
@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>org.fugerit.java</groupId>
 		<artifactId>fj-doc</artifactId>
-		<version>0.3.8.1</version>
+		<version>0.3.8.2</version>
 	</parent>
 
 	<name>fj-doc-freemarker</name>

diff --git a/fj-doc-mod-fop/pom.xml b/fj-doc-mod-fop/pom.xml
@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>org.fugerit.java</groupId>
 		<artifactId>fj-doc</artifactId>
-		<version>0.3.8.1</version>
+		<version>0.3.8.2</version>
 	</parent>
 
 	<name>fj-doc-mod-fop</name>

diff --git a/fj-doc-mod-itext/pom.xml b/fj-doc-mod-itext/pom.xml
@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>org.fugerit.java</groupId>
 		<artifactId>fj-doc</artifactId>
-		<version>0.3.8.1</version>
+		<version>0.3.8.2</version>
 	</parent>
 
 	<name>fj-doc-mod-itext</name>

diff --git a/fj-doc-mod-jxl/pom.xml b/fj-doc-mod-jxl/pom.xml
@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>org.fugerit.java</groupId>
 		<artifactId>fj-doc</artifactId>
-		<version>0.3.8.1</version>
+		<version>0.3.8.2</version>
 	</parent>
 
 	<name>fj-doc-mod-jxl</name>

diff --git a/fj-doc-mod-pdfbox/pom.xml b/fj-doc-mod-pdfbox/pom.xml
@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>org.fugerit.java</groupId>
 		<artifactId>fj-doc</artifactId>
-		<version>0.3.8.1</version>
+		<version>0.3.8.2</version>
 	</parent>
 
 	<name>fj-doc-mod-pdfbox</name>

diff --git a/fj-doc-mod-poi/pom.xml b/fj-doc-mod-poi/pom.xml
@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>org.fugerit.java</groupId>
 		<artifactId>fj-doc</artifactId>
-		<version>0.3.8.1</version>
+		<version>0.3.8.2</version>
 	</parent>
 
 	<name>fj-doc-mod-poi</name>

diff --git a/fj-doc-sample/pom.xml b/fj-doc-sample/pom.xml
@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>org.fugerit.java</groupId>
 		<artifactId>fj-doc</artifactId>
-		<version>0.3.8.1</version>
+		<version>0.3.8.2</version>
 	</parent>
 
 	<name>fj-doc-sample</name>

diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
 	<groupId>org.fugerit.java</groupId>
 	<artifactId>fj-doc</artifactId>
 
-	<version>0.3.8.1</version>
+	<version>0.3.8.2</version>
 	<packaging>pom</packaging>
 
 	<name>fj-doc</name>