Skip to content

Commit

Permalink
[FABCN-378] Update links to chaincode JSDoc
Browse files Browse the repository at this point in the history
Also fixes release in links to chaincode Javadoc

Signed-off-by: James Taylor <jamest@uk.ibm.com>
  • Loading branch information
jt-nti authored and mergify[bot] committed Jan 31, 2020
1 parent 721a6e7 commit 13d12e5
Show file tree
Hide file tree
Showing 10 changed files with 55 additions and 58 deletions.
6 changes: 3 additions & 3 deletions docs/source/build_network.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Next, you can bring the network up with one of the following commands:
The above command will compile Golang chaincode images and spin up the corresponding
containers. Go is the default chaincode language, however there is also support
for `Node.js <https://fabric-shim.github.io/>`_ and `Java <https://hyperledger.github.io/fabric-chaincode-java/>`_
for `Node.js <https://hyperledger.github.io/fabric-chaincode-node/>`_ and `Java <https://hyperledger.github.io/fabric-chaincode-java/>`_
chaincode. If you'd like to run through this tutorial with node chaincode, pass
the following command instead:
Expand All @@ -168,10 +168,10 @@ the following command instead:
./byfn.sh up -l javascript
.. note:: For more information on the Node.js shim, please refer to its
`documentation <https://fabric-shim.github.io/ChaincodeInterface.html>`_.
`documentation <https://hyperledger.github.io/fabric-chaincode-node/release-2.0/api/fabric-shim.ChaincodeInterface.html>`_.
.. note:: For more information on the Java shim, please refer to its
`documentation <https://hyperledger.github.io/fabric-chaincode-java/master/api/org/hyperledger/fabric/shim/Chaincode.html>`_.
`documentation <https://hyperledger.github.io/fabric-chaincode-java/release-2.0/api/org/hyperledger/fabric/shim/Chaincode.html>`_.
Тo make the sample run with Java chaincode, you have to specify ``-l java`` as follows:
Expand Down
8 changes: 4 additions & 4 deletions docs/source/chaincode4ade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ are called in response to received transactions. You can find the reference
documentation of the Chaincode Shim API for different languages below:

- `Go <https://godoc.org/github.com/hyperledger/fabric-chaincode-go/shim#Chaincode>`__
- `node.js <https://fabric-shim.github.io/ChaincodeInterface.html>`__
- `Java <https://hyperledger.github.io/fabric-chaincode-java/master/api/org/hyperledger/fabric/shim/Chaincode.html>`_
- `node.js <https://hyperledger.github.io/fabric-chaincode-node/release-2.0/api/fabric-shim.ChaincodeInterface.html>`__
- `Java <https://hyperledger.github.io/fabric-chaincode-java/release-2.0/api/org/hyperledger/fabric/shim/Chaincode.html>`_

In each language, the ``Invoke`` method is called by clients to submit transaction
proposals. This method allows you to use the chaincode to read and write data on
Expand All @@ -54,8 +54,8 @@ function by using the `peer chaincode invoke` command and passing the
The other interface in the chaincode "shim" APIs is the ``ChaincodeStubInterface``:

- `Go <https://godoc.org/github.com/hyperledger/fabric-chaincode-go/shim#ChaincodeStubInterface>`__
- `node.js <https://fabric-shim.github.io/ChaincodeStub.html>`__
- `Java <https://hyperledger.github.io/fabric-chaincode-java/master/api/org/hyperledger/fabric/shim/ChaincodeStub.html>`_
- `node.js <https://hyperledger.github.io/fabric-chaincode-node/release-2.0/api/fabric-shim.ChaincodeStub.html>`__
- `Java <https://hyperledger.github.io/fabric-chaincode-java/release-2.0/api/org/hyperledger/fabric/shim/ChaincodeStub.html>`_

which is used to access and modify the ledger, and to make invocations between
chaincodes.
Expand Down
3 changes: 0 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,3 @@ def setup(app):

# Increase the linkcheck timeout to 5 seconds
linkcheck_timeout = 5

# Ignore redirects from fabric-shim.github.io
linkcheck_ignore = [r'https://fabric-shim.github.io/*']
2 changes: 1 addition & 1 deletion docs/source/developapps/chaincodenamespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ Notice how:
See interaction points **2a**, **2b**, **2c** and **2d**.

Control is passed between chaincode using the `invokeChaincode()`
[API](https://fabric-shim.github.io/master/fabric-shim.ChaincodeStub.html#invokeChaincode__anchor).
[API](https://hyperledger.github.io/fabric-chaincode-node/release-2.0/api/fabric-shim.ChaincodeStub.html#invokeChaincode__anchor).
This API passes control from one chaincode to another chaincode.

Although we have only discussed query transactions in the example, it is
Expand Down
4 changes: 2 additions & 2 deletions docs/source/developapps/smartcontract.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ and **redeem**. It's these transactions that bring commercial papers into
existence and move them through their lifecycle. We'll examine these
[transactions](#transaction-definition) soon, but for now notice for JavaScript, that the
`CommericalPaperContract` extends the Hyperledger Fabric `Contract`
[class](https://fabric-shim.github.io/release-1.4/fabric-contract-api.Contract.html).
[class](https://hyperledger.github.io/fabric-chaincode-node/release-2.0/api/fabric-contract-api.Contract.html).

With Java, the class must be decorated with the `@Contract(...)` annotation. This provides the opportunity
to supply additional information about the contract, such as license and author. The `@Default()` annotation
Expand All @@ -99,7 +99,7 @@ If you are using a TypeScript implementation, there are similar `@Contract(...)`

For more information on the available annotations, consult the available API documentation:
* [API documentation for Java smart contracts](https://hyperledger.github.io/fabric-chaincode-java/)
* [API documentation for Node.js smart contracts](https://fabric-shim.github.io/)
* [API documentation for Node.js smart contracts](https://hyperledger.github.io/fabric-chaincode-node/)

These classes, annotations, and the `Context` class, were brought into scope earlier:

Expand Down
Loading

0 comments on commit 13d12e5

Please sign in to comment.