Fix javadoc build

Signed-off-by: James Taylor <[email protected]>

Author: jt-nti

ci/azure-pipelines.yml

@@ -65,6 +65,7 @@ stages:
               javaHomeOption: "JDKVersion"
               jdkVersionOption: "1.8"
               jdkArchitectureOption: "x64"
+              options: "-x javadoc"
               publishJUnitResults: true
               testResultsFiles: "$(System.DefaultWorkingDirectory)/**/TEST-*.xml"
               tasks: "build"
@@ -122,7 +123,6 @@ stages:
 
       - job: javadoc
         dependsOn: displayenv
-        condition: and(succeeded(),eq(variables['Build.Reason'], 'IndividualCI'))
         variables:
           ${{ if eq(variables['Build.SourceBranch'], 'refs/heads/master') }}:
             javadoc_release: master
@@ -159,6 +159,7 @@ stages:
               git commit -m "Publishing GitHub Pages"
               git push https://$(GITHUB-PAT)@github.com/hyperledger/fabric-chaincode-java.git gh-pages
             displayName: 'Commit gh-pages changes'
+            condition: and(succeeded(),eq(variables['Build.Reason'], 'IndividualCI'))
 
   # As the next script is more complex and uses loops, run this discretely in a sh file
   # Publishing step for git tags

fabric-chaincode-shim/build.gradle

@@ -213,20 +213,24 @@ task licenseCheck {
 
 
 javadoc {
-    failOnError = false
+    failOnError = true
     excludes = ['org/hyperledger/fabric/contract/ContextFactory.java',
                 'org/hyperledger/fabric/contract/ContractRouter.java',
                 'org/hyperledger/fabric/contract/ContractRuntimeException.java',
                 'org/hyperledger/fabric/contract/execution/**',
                 'org/hyperledger/fabric/contract/metadata/**',
                 'org/hyperledger/fabric/contract/routing/**',
                 'org/hyperledger/fabric/contract/systemcontract/**',
-                'org/hyperledger/fabric/**/impl/**',
+                'org/hyperledger/fabric/ledger/**',
                 'org/hyperledger/fabric/shim/helper/**',
-                'org/hyperledger/fabric/shim/ChaincodeBase.java']
+                'org/hyperledger/fabric/**/impl/**']
+
     source = sourceSets.main.allJava
 
-    classpath = sourceSets.main.compileClasspath
+    classpath = sourceSets.main.runtimeClasspath
+    
+    javadoc.options.addStringOption('Xdoclint:none', '-quiet')
+    options.overview = "src/main/java/org/hyperledger/fabric/overview.html"
 }
 
 if (JavaVersion.current().isJava8Compatible()) {

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/ContractInterface.java

@@ -16,7 +16,7 @@
  * All methods on this interface have default implementations; for
  * many contracts it may not be needed to sub-class these.
  * <p>
- * Each method on the Contract that is marked with the {@link Transaction}
+ * Each method on the Contract that is marked with the {@link org.hyperledger.fabric.contract.annotation.Transaction}
  * annotation is considered a Transaction Function. This is eligible for
  * calling. Each transaction function is supplied with its first parameter
  * being a {@link org.hyperledger.fabric.contract.Context}. The other parameters

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/ContractRouter.java

@@ -30,6 +30,8 @@
 /**
  * Router class routes Init/Invoke requests to contracts. Implements
  * {@link org.hyperledger.fabric.shim.Chaincode} interface.
+ *
+ * @see ContractInterface
  */
 public final class ContractRouter extends ChaincodeBase {
     private static Logger logger = Logger.getLogger(ContractRouter.class.getName());

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/annotation/package-info.java

@@ -5,6 +5,8 @@
  */
 
 /**
-
+ * Provides annotations required for Contract implementations.
+ *
+ * @see org.hyperledger.fabric.contract.ContractInterface
  */
 package org.hyperledger.fabric.contract.annotation;

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/execution/JSONTransactionSerializer.java

@@ -155,9 +155,6 @@ private JSONArray normalizeArray(final JSONArray jsonArray, final TypeSchema ts)
      * @param ts     TypeSchema representing the type
      *
      * @return Object created; relies on Java auto-boxing for primitives
-     *
-     * @throws InstantiationException
-     * @throws IllegalAccessException
      */
     @Override
     public Object fromBuffer(final byte[] buffer, final TypeSchema ts) {

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/execution/SerializerInterface.java

@@ -37,9 +37,6 @@ public interface SerializerInterface {
      * @param ts     TypeSchema representing the type
      *
      * @return Object created; relies on Java auto-boxing for primitives
-     *
-     * @throws InstantiationException
-     * @throws IllegalAccessException
      */
     Object fromBuffer(byte[] buffer, TypeSchema ts);
 

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/package-info.java

@@ -5,22 +5,17 @@
  */
 
 /**
- * <p>
- * This is the project to support the writing of Contracts with the JVM runtime
- * - enabling development of using Java language or other JVM based languages
+ * Provides interfaces and classes to support the contract programming model.
+ *
  * <p>
  * The {@link org.hyperledger.fabric.contract} package implements the Fabric
  * programming model as described in the <a href=
- * "https://hyperledger-fabric.readthedocs.io/en/release-1.4/developapps/developing_applications.html">Developing
+ * "https://hyperledger-fabric.readthedocs.io/en/latest/developapps/developing_applications.html">Developing
  * Applications</a> chapter of the Fabric documentation.
- * </p>
+ *
  * <p>
  * The main interface to implement is
- * {@link org.hyperledger.fabric.contract#ContractInterface}
- *
- * @see <a href=
- *      "https://hyperledger-fabric.readthedocs.io/en/release-1.4/developapps/developing_applications.html">Developing
- *      Fabric Applications</a>
+ * {@link org.hyperledger.fabric.contract.ContractInterface}
  *
  */
 package org.hyperledger.fabric.contract;

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/routing/impl/SerializerRegistryImpl.java

@@ -66,7 +66,7 @@ private SerializerInterface add(final String name, final Serializer.TARGET targe
     /**
      * Find all the serializers that have been defined.
      *
-     * @see org.hyperledger.fabric.contract.routing.RoutingRegistry#findAndSetContracts()
+     * @see org.hyperledger.fabric.contract.routing.RoutingRegistry#findAndSetContracts(TypeRegistry)
      * @throws IllegalAccessException
      * @throws InstantiationException
      */

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/ledger/package-info.java

@@ -6,7 +6,7 @@
 
 /**
  * <p>
- * This package provides the API for contracts to access the shared ledger.
+ * Provides the API for contracts to access the shared ledger.
  *
  */
 package org.hyperledger.fabric.ledger;