adds comments to generated code

hyperledger-web3j · Jan 11, 2021 · 34c0112 · 34c0112
1 parent 57e9ac2
commit 34c0112
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 0 deletions.
diff --git a/src/main/resources/project/EmptyJava.template b/src/main/resources/project/EmptyJava.template
@@ -1,5 +1,9 @@
 package <package_name>;
 
+/**
+ * <p>This is the generated class for <code>web3j import</code></p>
+ * <p>For more information on how to run this project, please refer to our <a href="https://docs.web3j.io/quickstart/#deployment">documentation</a></p>
+ */
 public class <project_name> {
 
     public static void main(String[]args) {

diff --git a/src/main/resources/project/EmptyKotlin.template b/src/main/resources/project/EmptyKotlin.template
@@ -1,5 +1,9 @@
 package <package_name>;
 
+/**
+ * <p>This is the generated class for <code>web3j import</code></p>
+ * <p>For more information on how to run this project, please refer to our <a href="https://docs.web3j.io/quickstart/#deployment">documentation</a></p>
+ */
 class <project_name> {
 
     companion object {

diff --git a/src/main/resources/project/Java.template b/src/main/resources/project/Java.template
@@ -7,6 +7,11 @@ import org.web3j.protocol.Web3j;
 import org.web3j.protocol.http.HttpService;
 import org.web3j.tx.gas.DefaultGasProvider;
 
+/**
+ * <p>This is the generated class for <code>web3j new helloworld</code></p>
+ * <p>It deploys the Hello World contract in src/main/solidity/ and prints its address</p>
+ * <p>For more information on how to run this project, please refer to our <a href="https://docs.web3j.io/quickstart/#deployment">documentation</a></p>
+ */
 public class <project_name> {
 
    private static final String nodeUrl = System.getenv().getOrDefault("WEB3J_NODE_URL", "<node_url>");

diff --git a/src/main/resources/project/Kotlin.template b/src/main/resources/project/Kotlin.template
@@ -4,6 +4,11 @@ import org.web3j.crypto.WalletUtils
 import org.web3j.protocol.Web3j
 import org.web3j.tx.gas.DefaultGasProvider
 
+/**
+ * <p>This is the generated class for <code>web3j new helloworld --kotlin</code></p>
+ * <p>It deploys the Hello World contract in src/main/solidity/ and prints its address</p>
+ * <p>For more information on how to run this project, please refer to our <a href="https://docs.web3j.io/quickstart/#deployment">documentation</a></p>
+ */
 class <project_name> {
 
     private val nodeUrl = System.getenv().getOrDefault("WEB3J_NODE_URL", "<node_url>")