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
This commit is contained in:
Ross Nicoll
2017-09-21 14:46:36 +01:00
committed by josecoll
parent 7e977c4118
commit b0e9183850
11 changed files with 24 additions and 21 deletions

View File

@ -18,7 +18,7 @@ import java.math.RoundingMode
import java.time.LocalDate
import java.util.*
val IRS_PROGRAM_ID = "net.corda.irs.contract.InterestRateSwap"
const val IRS_PROGRAM_ID = "net.corda.irs.contract.InterestRateSwap"
// This is a placeholder for some types that we haven't identified exactly what they are just yet for things still in discussion
@CordaSerializable

View File

@ -1,6 +1,7 @@
package net.corda.vega.contracts
import net.corda.core.contracts.Command
import net.corda.core.contracts.ContractClassName
import net.corda.core.contracts.StateAndContract
import net.corda.core.contracts.UniqueIdentifier
import net.corda.core.identity.AbstractParty
@ -8,7 +9,7 @@ import net.corda.core.identity.Party
import net.corda.core.transactions.TransactionBuilder
import net.corda.finance.contracts.DealState
val IRS_PROGRAM_ID = "net.corda.vega.contracts.OGTrade"
const val IRS_PROGRAM_ID: ContractClassName = "net.corda.vega.contracts.OGTrade"
/**
* Represents an OpenGamma IRS between two parties. Does not implement any fixing functionality.