diff --git a/docs/build/html/_sources/codestyle.txt b/docs/build/html/_sources/codestyle.txt index 681884292c..2e15c7fd28 100644 --- a/docs/build/html/_sources/codestyle.txt +++ b/docs/build/html/_sources/codestyle.txt @@ -52,6 +52,14 @@ Code is vertically dense, blank lines in methods are used sparingly. This is so We use spaces and not tabs. +1.2 Naming +---------- + +Naming generally follows Java standard style (pascal case for class names, camel case for methods, properties and +variables). Where a class name describes a tuple, "And" should be included in order to clearly indicate the elements are +individual parts, for example ``PartyAndReference``, not ``PartyReference`` (which sounds like a reference to a +``Party``). + 2. Comments ########### @@ -177,4 +185,3 @@ instead do this The latter is easier to catch and handle if later necessary, and the type name should explain what went wrong. Note that Kotlin does not require exception types to be declared in method prototypes like Java does. - diff --git a/docs/build/html/api/alltypes/index.html b/docs/build/html/api/alltypes/index.html index 3cb9c2ed05..a569f7d2c6 100644 --- a/docs/build/html/api/alltypes/index.html +++ b/docs/build/html/api/alltypes/index.html @@ -918,7 +918,7 @@ functionality to Java, but it wont arrive for a few years yet
Reference to something being stored or issued by a party e.g. in a vault or (more likely) on their normal ledger. The reference is intended to be encrypted so its meaningless to anyone other than the party.
diff --git a/docs/build/html/api/contracts/-cash/-state/-init-.html b/docs/build/html/api/contracts/-cash/-state/-init-.html index 2d4898ad5b..fee165d2a1 100644 --- a/docs/build/html/api/contracts/-cash/-state/-init-.html +++ b/docs/build/html/api/contracts/-cash/-state/-init-.html @@ -7,7 +7,7 @@ contracts / Cash / State / <init>State(deposit: PartyReference, amount: Amount, owner: PublicKey)
State(deposit: PartyAndReference, amount: Amount, owner: PublicKey)
A state representing a cash claim against some party
val deposit: PartyReference
val deposit: PartyAndReference
Where the underlying currency backing this ledger entry can be found (propagated)
State(deposit: PartyReference, amount: Amount, owner: PublicKey)
A state representing a cash claim against some party
+State(deposit: PartyAndReference, amount: Amount, owner: PublicKey)
A state representing a cash claim against some party
val deposit: PartyReference
Where the underlying currency backing this ledger entry can be found (propagated)
+val deposit: PartyAndReference
Where the underlying currency backing this ledger entry can be found (propagated)
fun generateIssue(tx: TransactionBuilder, amount: Amount, at: PartyReference, owner: PublicKey): Unit
fun generateIssue(tx: TransactionBuilder, amount: Amount, at: PartyAndReference, owner: PublicKey): Unit
Puts together an issuance transaction for the specified amount that starts out being owned by the given pubkey.
fun generateIssue(tx: TransactionBuilder, amount: Amount, at: PartyReference, owner: PublicKey): Unit
Puts together an issuance transaction for the specified amount that starts out being owned by the given pubkey.
+fun generateIssue(tx: TransactionBuilder, amount: Amount, at: PartyAndReference, owner: PublicKey): Unit
Puts together an issuance transaction for the specified amount that starts out being owned by the given pubkey.
State(issuance: PartyReference, owner: PublicKey, faceValue: Amount, maturityDate: Instant)
State(issuance: PartyAndReference, owner: PublicKey, faceValue: Amount, maturityDate: Instant)