ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-06-05 09:00:53 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Joel move api docs

Browse Source
This commit is contained in:
Joel Dudley 2017-10-09 11:32:03 +01:00 committed by GitHub
parent a9508b393c
commit 0c2289de8c
6 changed files with 8 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/source/building-a-cordapp-index.rst
View File

@ -7,5 +7,6 @@ Building a CorDapp
cordapp-overview cordapp-overview
writing-cordapps writing-cordapps
cordapp-build-systems cordapp-build-systems
corda-api
flow-cookbook flow-cookbook
cheat-sheet cheat-sheet

6
docs/source/corda-modules.rst → docs/source/corda-api.rst
View File

@ -1,7 +1,7 @@
Corda modules Corda API
============= =========
This section describes the APIs that are available for the development of CorDapps: The following are the core APIs that are used in the development of CorDapps:
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

2
docs/source/getting-set-up.rst
View File

@ -169,7 +169,7 @@ The best way to check that everything is working fine is by taking a deeper look
Next, you should read through :doc:`Corda Key Concepts <key-concepts>` to understand how Corda works. Next, you should read through :doc:`Corda Key Concepts <key-concepts>` to understand how Corda works.
By then, you'll be ready to start writing your own CorDapps. Learn how to do this in the By then, you'll be ready to start writing your own CorDapps. Learn how to do this in the
:doc:`Hello, World tutorial <hello-world-index>`. You may want to refer to the :doc:`Modules documentation <corda-modules>` along the :doc:`Hello, World tutorial <hello-world-index>`. You may want to refer to the :doc:`API documentation <corda-api>` along the
way. way.
If you encounter any issues, please see the :doc:`troubleshooting` page, or get in touch with us on the If you encounter any issues, please see the :doc:`troubleshooting` page, or get in touch with us on the

8
docs/source/hello-world-running.rst
View File

@ -117,13 +117,7 @@ commands.
We want to create an IOU of 100 with PartyB. We start the ``IOUFlow`` by typing: We want to create an IOU of 100 with PartyB. We start the ``IOUFlow`` by typing:
.. container:: codeset .. code:: bash
.. code-block:: java
start IOUFlow arg0: 99, arg1: "O=PartyB,L=New York,C=US"
.. code-block:: kotlin
start IOUFlow iouValue: 99, otherParty: "O=PartyB,L=New York,C=US" start IOUFlow iouValue: 99, otherParty: "O=PartyB,L=New York,C=US"

1
docs/source/other-index.rst
View File

@ -7,6 +7,5 @@ Other
json json
secure-coding-guidelines secure-coding-guidelines
corda-repo-layout corda-repo-layout
corda-modules
building-the-docs building-the-docs
codestyle codestyle

2
docs/source/release-notes.rst
View File

@ -32,7 +32,7 @@ Our extensive testing frameworks will continue to evolve alongside future Corda
we have introduced a new test node driver module to encapsulate all test functionality in support of building standalone node integration we have introduced a new test node driver module to encapsulate all test functionality in support of building standalone node integration
tests using our DSL driver. tests using our DSL driver.
Please read :doc:`corda-modules` for complete details. Please read :doc:`corda-api` for complete details.
.. note:: it may be necessary to recompile applications against future versions of the API until we begin offering .. note:: it may be necessary to recompile applications against future versions of the API until we begin offering
`ABI (Application Binary Interface) <https://en.wikipedia.org/wiki/Application_binary_interface>`_ stability as well. `ABI (Application Binary Interface) <https://en.wikipedia.org/wiki/Application_binary_interface>`_ stability as well.