ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-20 05:28:21 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Docs: more package descriptions and take non-stabilised APIs out of the docs build. (#1775)

Browse Source
This commit is contained in:
Mike Hearn 2017-10-02 16:54:13 +01:00 committed by josecoll
parent 8c95d0b11a
commit b01a8c548a
2 changed files with 53 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/build.gradle
View File

@ -9,7 +9,9 @@ dokka {
moduleName = 'corda' moduleName = 'corda'
outputDirectory = file("${rootProject.rootDir}/docs/build/html/api/kotlin") outputDirectory = file("${rootProject.rootDir}/docs/build/html/api/kotlin")
processConfigurations = ['compile'] processConfigurations = ['compile']
sourceDirs = files('../core/src/main/kotlin', '../client/jfx/src/main/kotlin', '../client/mock/src/main/kotlin', '../client/rpc/src/main/kotlin', '../node-api/src/main/kotlin', '../finance/src/main/kotlin', '../client/jackson/src/main/kotlin', '../testing/node-driver/src/main/kotlin', '../testing/test-utils/src/main/kotlin') // TODO: Re-add '../testing/node-driver/src/main/kotlin', '../testing/test-utils/src/main/kotlin' when they're API stable
// TODO: Add '../client/jfx/src/main/kotlin' and '../client/mock/src/main/kotlin' if we decide to make them into public API
sourceDirs = files('../core/src/main/kotlin', '../client/rpc/src/main/kotlin', '../finance/src/main/kotlin', '../client/jackson/src/main/kotlin')
includes = ['packages.md'] includes = ['packages.md']
jdkVersion = 8 jdkVersion = 8
@ -29,7 +31,8 @@ task dokkaJavadoc(type: org.jetbrains.dokka.gradle.DokkaTask) {
outputFormat = "javadoc" outputFormat = "javadoc"
outputDirectory = file("${rootProject.rootDir}/docs/build/html/api/javadoc") outputDirectory = file("${rootProject.rootDir}/docs/build/html/api/javadoc")
processConfigurations = ['compile'] processConfigurations = ['compile']
sourceDirs = files('../core/src/main/kotlin', '../client/jfx/src/main/kotlin', '../client/mock/src/main/kotlin', '../client/rpc/src/main/kotlin', '../node-api/src/main/kotlin', '../finance/src/main/kotlin', '../client/jackson/src/main/kotlin', '../testing/node-driver/src/main/kotlin', '../testing/test-utils/src/main/kotlin') // TODO: Make this a copy of the list above programmatically.
sourceDirs = files('../core/src/main/kotlin', '../client/rpc/src/main/kotlin', '../finance/src/main/kotlin', '../client/jackson/src/main/kotlin')
includes = ['packages.md'] includes = ['packages.md']
jdkVersion = 8 jdkVersion = 8

63
docs/packages.md
View File

@ -3,19 +3,6 @@
Utilities and serialisers for working with JSON representations of basic types. This adds Jackson support for Utilities and serialisers for working with JSON representations of basic types. This adds Jackson support for
the java.time API, some core types, and Kotlin data classes. the java.time API, some core types, and Kotlin data classes.
# Package net.corda.client.jfx.model
Data models for binding data feeds from Corda nodes into a JavaFX user interface, by presenting the data as [javafx.beans.Observable]
types.
# Package net.corda.client.jfx.utils
Utility classes (i.e. data classes) used by the Corda JavaFX client.
# Package net.corda.client.mock
Tools used by the client to produce mock data for testing purposes.
# Package net.corda.client.rpc # Package net.corda.client.rpc
RPC client interface to Corda, for use both by user-facing client and integration with external systems. RPC client interface to Corda, for use both by user-facing client and integration with external systems.
@ -99,12 +86,58 @@ actual states rather than state references).
Corda utility classes, providing a broad range of functionality to help implement both Corda nodes and CorDapps. Corda utility classes, providing a broad range of functionality to help implement both Corda nodes and CorDapps.
# Package net.corda.finance # Package net.corda.finance
The finance module is a CorDapp containing sample cash and obligation contracts, as well as providing several Some simple testing utilities like pre-defined top-level values for common currencies. Mostly useful for
useful data types such as [Amount]. writing unit tests in Kotlin.
WARNING: NOT API STABLE.
# Package net.corda.finance.utils # Package net.corda.finance.utils
A collection of utilities for summing financial states, for example, summing obligations to get total debts. A collection of utilities for summing financial states, for example, summing obligations to get total debts.
WARNING: NOT API STABLE.
# Package net.corda.finance.contracts
Various types for common financial concepts like day roll conventions, fixes, etc.
WARNING: NOT API STABLE.
# net.corda.finance.contracts.asset
Cash states, obligations and commodities.
WARNING: NOT API STABLE.
# net.corda.finance.contracts.asset.cash.selection
Provisional support for pluggable cash selectors, needed for different database backends.
WARNING: NOT API STABLE.
# net.corda.finance.contracts.math
Splines and interpolation.
WARNING: NOT API STABLE.
# net.corda.finance.flows
Cash payments and issuances. Two party "delivery vs payment" atomic asset swaps.
WARNING: NOT API STABLE.
# net.corda.finance.plugin
JSON/Jackson plugin for business calendars.
WARNING: NOT API STABLE.
# net.corda.finance.schemas
JPA (Java Persistence Architecture) schemas for the financial state types.
WARNING: NOT API STABLE.