Ross Nicoll b0e9183850 CORDA-499: Dokka cleanup for 1.0 (#1579) ...

* Clean up Dokka comments on CordaRPCOps

* Remove use of "e.g." which Dokka will take as end of the first sentence
* Move example onto function that it actually works with
* Change comment which refers to comment above it, without any linkage, to directly describe the function
* Move implementation notes out of Dokka comment

* Make functions in CompositeSignature static

* Make contract IDs constant

* Correct contract ID in CashTestsJava

2017-09-21 14:46:36 +01:00

..

_static

Updates cheatsheet to reflect API changes up to M14.

2017-08-15 11:35:11 +01:00

_templates

Adds a missing bracket. (#1107)

2017-07-25 11:31:24 +01:00

example-code

CORDA-499: Dokka cleanup for 1.0 (#1579)

2017-09-21 14:46:36 +01:00

resources

Updates the transaction API page and cookbook.

2017-08-25 17:15:39 +01:00

whitepaper

added correct 'figure' translation for traditional chinese.

2017-05-08 14:36:29 +02:00

api-contracts.rst

Renames AuthenticatedObject to CommandWithParties for clarity.

2017-09-01 14:10:35 +01:00

api-core-types.rst

Addresses review feedback.

2017-09-01 14:50:29 +01:00

api-flows.rst

Update api-flows.rst.

2017-08-31 10:09:31 +01:00

api-index.rst

[fix] stop the API pages being orphaned away from the menu

2017-08-02 10:37:40 +01:00

api-persistence.rst

Improved support for testing custom schemas using a MockNetwork. (#1450)

2017-09-13 12:06:24 +01:00

api-rpc.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

api-service-hub.rst

NodeInfo remove main identity (#1284)

2017-09-15 14:39:34 +01:00

api-states.rst

Restore ContractState and TransactionState to docs. (#1495)

2017-09-13 11:49:05 +01:00

api-transactions.rst

Updates the transaction API page and cookbook.

2017-08-25 17:15:39 +01:00

api-vault-query.rst

Improved support for testing custom schemas using a MockNetwork. (#1450)

2017-09-13 12:06:24 +01:00

azure-vm.rst

Docsite reorg ahead of beta launch.

2017-06-05 13:37:23 +01:00

building-a-cordapp-index.rst

Added corda and cordaRuntime configurations and documentation on integrating with Corda (#1103)

2017-07-25 17:54:36 +01:00

building-against-master.rst

Updates the example CorDapp page.

2017-07-21 12:33:31 +01:00

building-the-docs.rst

Removed old information about Dokka from the building docs documentation.

2017-03-30 12:23:20 +01:00

changelog.rst

Clean up API for selecting notaries (#1573)

2017-09-21 10:28:18 +01:00

cheat-sheet.rst

Adds the cheat sheet to the docsite. (#556)

2017-05-03 12:59:40 +01:00

clauses.rst

Renames AuthenticatedObject to CommandWithParties for clarity.

2017-09-01 14:10:35 +01:00

CLI-vs-IDE.rst

Final documentation tweaks for M11 (#632)

2017-05-05 08:30:58 +01:00

clientrpc.rst

Fixes indentation of note box.

2017-08-17 17:26:10 +01:00

codestyle.rst

Regen docsite with new JavaDoc format API reference

2017-01-18 13:42:22 +01:00

component-library-index.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

conf.py

Uses dynamic loading of dropdown versions. Styles box slightly.

2017-07-24 18:25:05 +01:00

contract-catalogue.rst

Pluggable cash selection using H2 as default implementation. (#1300)

2017-08-22 18:09:23 +01:00

contract-irs.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

contract-upgrade.rst

Contract Upgrade API improvements + persistence (#1392)

2017-09-05 13:23:19 +01:00

corda-configuration-file.rst

[CORDA-461] Remove deprecated APIs. (#1480)

2017-09-13 15:39:39 +01:00

corda-networks-index.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

corda-nodes-index.rst

Updates the example CorDapp page.

2017-07-21 12:33:31 +01:00

corda-repo-layout.rst

Cordform common is now a part of the gradle plugin suite (#1474)

2017-09-12 19:18:09 +01:00

cordapp-build-systems.rst

Introduced FlowLogic.getFlowContext which provides the flow version and app name of the other side.

2017-08-11 18:01:16 +01:00

cordapp-overview.rst

CORDA-593 - Strip web front end from the SIMM demo (#1574)

2017-09-21 09:05:32 +01:00

demobench.rst

Update documentation for DemoBench's MacOSX signing key. (#826)

2017-06-12 12:50:22 +01:00

deploying-a-node.rst

Enforce X500Name format defined in design doc (#1427)

2017-09-07 14:47:42 +01:00

event-scheduling.rst

Introducing StartableByRPC and SchedulableFlow annotations, needed by flows started via RPC and schedulable flows respectively.

2017-05-11 14:55:40 +01:00

faq.rst

Changes master docs to reflect M12 last-minute changes.

2017-06-09 13:59:39 +01:00

financial-model.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

flow-cookbook.rst

Flow cookbook added and merged into flow API page.

2017-06-22 16:13:54 +01:00

flow-library.rst

Replace data vending service with SendTransactionFlow (#964)

2017-08-04 11:26:31 +01:00

flow-state-machines.rst

Remove advertised services from NodeInfo (#1521)

2017-09-20 13:19:57 +01:00

flow-testing.rst

Remove advertised services from NodeInfo (#1521)

2017-09-20 13:19:57 +01:00

getting-set-up.rst

Makes set-up instructions clearer. Addresses a zsh-related bug.

2017-09-05 12:33:52 +02:00

glossary.rst

Kryo serialisation whitelisting and misc enhancements. (#267)

2017-02-28 08:12:18 +00:00

hello-world-contract.rst

Renames AuthenticatedObject to CommandWithParties for clarity.

2017-09-01 14:10:35 +01:00

hello-world-flow.rst

NodeInfo remove main identity (#1284)

2017-09-15 14:39:34 +01:00

hello-world-index.rst

Hello, World! CorDapp tutorial

2017-06-16 14:05:52 +01:00

hello-world-introduction.rst

Simplifies the Hello, World tutorial.

2017-07-07 12:06:28 +01:00

hello-world-running.rst

Enforce X500Name format defined in design doc (#1427)

2017-09-07 14:47:42 +01:00

hello-world-state.rst

ContractState now references contract by class name (#1407)

2017-09-11 16:44:18 +01:00

hello-world-template.rst

Additional fixes to the tutorial.

2017-08-17 12:02:44 +01:00

index.rst

Adds a link to Hello, Word. Other minor fixes.

2017-06-20 11:26:36 +01:00

json.rst

Document JSON/Jackson support

2017-03-08 12:31:22 +01:00

key-concepts-consensus.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

key-concepts-contracts.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

key-concepts-ecosystem.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

key-concepts-flows.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

key-concepts-ledger.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

key-concepts-node.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

key-concepts-notaries.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

key-concepts-oracles.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

key-concepts-states.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

key-concepts-time-windows.rst

Changes master docs to reflect M12 last-minute changes.

2017-06-09 13:59:39 +01:00

key-concepts-tradeoffs.rst

Docsite reorg ahead of beta launch.

2017-06-05 13:37:23 +01:00

key-concepts-transactions.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

key-concepts.rst

Refresh for beta release (#819)

2017-06-08 17:15:46 +01:00

loadtesting.rst

Added throttling to the load test tool and added stability test. (#847)

2017-06-16 15:30:11 +01:00

messaging.rst

Removed out-of-date warnings regarding the switchover to X.500 names

2017-07-25 13:16:10 +01:00

network-simulator.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

node-administration.rst

Update doc to show JMX no longer works in Corda, due to the serialisation changes (#922)

2017-06-28 11:29:34 +01:00

node-database.rst

Updates the example CorDapp page.

2017-07-21 12:33:31 +01:00

node-explorer.rst

Reduce occurrence of flow exception in explorer demo (#467)

2017-03-31 14:19:02 +01:00

node-internals-index.rst

Cleaned up incorrect references to vault query and persistence. (#933)

2017-06-28 16:00:39 +01:00

node-services.rst

Removed PluginServiceHub

2017-09-14 09:30:37 +01:00

oracles.rst

Removed PluginServiceHub

2017-09-14 09:30:37 +01:00

other-index.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

out-of-process-verification.rst

Docsite reorg ahead of beta launch.

2017-06-05 13:37:23 +01:00

permissioning.rst

Removed out-of-date warnings regarding the switchover to X.500 names

2017-07-25 13:16:10 +01:00

quickstart-index.rst

Updates the example CorDapp page.

2017-07-21 12:33:31 +01:00

release-notes.rst

Remove IssuerFlow

2017-08-15 22:32:30 +01:00

release-process-index.rst

Addressed release comments.

2017-09-05 17:38:53 +01:00

running-a-node.rst

Adds information on writing CorDapps. Reorg.

2017-07-25 09:26:35 +01:00

running-a-notary.rst

extraAdvertisedServiceIds config is now a list of strings, rather than a comma separated string

2017-02-21 15:21:37 +00:00

running-the-demos.rst

Minor changes to code documentation (#1585)

2017-09-21 14:43:10 +01:00

secure-coding-guidelines.rst

Docsite reorg ahead of beta launch.

2017-06-05 13:37:23 +01:00

serialization.rst

Adds information on writing CorDapps. Reorg.

2017-07-25 09:26:35 +01:00

setting-up-a-corda-network.rst

Docsite reorg ahead of beta launch.

2017-06-05 13:37:23 +01:00

shell.rst

Enforce X500Name format defined in design doc (#1427)

2017-09-07 14:47:42 +01:00

soft-locking.rst

Improvements to Vault Query Service soft locked state querying (#1174)

2017-08-04 17:23:31 +01:00

testing.rst

Addressed release comments.

2017-09-05 17:38:53 +01:00

tools-index.rst

Further docsite changes, including reorganising the index.

2017-06-07 16:14:01 +01:00

troubleshooting.rst

Docs: Add a note to the troubleshooting page about the -javaagent flag.

2017-07-14 18:21:33 +01:00

tut-two-party-contract.rst

Additional fixes to the tutorial.

2017-08-17 12:02:44 +01:00

tut-two-party-flow.rst

Additional fixes to the tutorial.

2017-08-17 12:02:44 +01:00

tut-two-party-index.rst

Additional fixes to the tutorial.

2017-08-17 12:02:44 +01:00

tut-two-party-introduction.rst

Removes repo link in tut to lower maint. overhead. (#1567)

2017-09-20 14:52:33 +01:00

tutorial-attachments.rst

Replace data vending service with SendTransactionFlow (#964)

2017-08-04 11:26:31 +01:00

tutorial-building-transactions.rst

Make a generic generate spend. Tests pass.

2017-08-10 13:29:08 +01:00

tutorial-clientrpc-api.rst

Rename finance module to own package

2017-08-22 13:25:31 +01:00

tutorial-contract-clauses.rst

Renames AuthenticatedObject to CommandWithParties for clarity.

2017-09-01 14:10:35 +01:00

tutorial-contract.rst

ContractState now references contract by class name (#1407)

2017-09-11 16:44:18 +01:00

tutorial-cordapp.rst

Removal of non-used webserver (#1572)

2017-09-21 11:20:42 +01:00

tutorial-custom-notary.rst

Removed PluginServiceHub

2017-09-14 09:30:37 +01:00

tutorial-integration-testing.rst

Fix IntegrationTestingTutorial network map race condition (#947)

2017-06-30 16:29:57 +01:00

tutorial-tear-offs.rst

Adding createSignature(filteredTransaction) to serviceHub (#1380)

2017-09-01 10:45:01 +01:00

tutorial-test-dsl.rst

Update code snippets in tutorial.

2017-06-08 13:39:14 +01:00

tutorials-index.rst

Adds a tutorial showing multi-party communication.

2017-07-17 12:23:14 +01:00

using-a-notary.rst

NodeInfo remove main identity (#1284)

2017-09-15 14:39:34 +01:00

vault.rst

Cleaned up incorrect references to vault query and persistence. (#933)

2017-06-28 16:00:39 +01:00

versioning.rst

Introduced FlowLogic.getFlowContext which provides the flow version and app name of the other side.

2017-08-11 18:01:16 +01:00

writing-cordapps.rst

Improved support for testing custom schemas using a MockNetwork. (#1450)

2017-09-13 12:06:24 +01:00