mirror of
https://github.com/digital-asset/daml.git
synced 2024-09-20 01:07:18 +03:00
clear scaladoc warnings in ledger-service, extractor, navigator (#3367)
* clear lf-value-json scaladoc warnings * clear extractor scaladoc warnings * clear navigator scaladoc warnings
This commit is contained in:
parent
41ae9709d4
commit
3fa4a2db2b
@ -14,7 +14,7 @@ import scalaz._
|
||||
object Types {
|
||||
|
||||
/**
|
||||
* Like [[iface.Type]], without `TypeVar`s
|
||||
* Like `iface.Type`, without `TypeVar`s
|
||||
*/
|
||||
sealed abstract class FullyAppliedType extends Product with Serializable
|
||||
|
||||
|
@ -8,7 +8,7 @@ import scalaz.{Lens => _, _}
|
||||
import Scalaz._
|
||||
|
||||
/** Lens to extract actually required values from `Option`al fields
|
||||
* as in the types like [[com.digitalasset.ledger.api.v1.value.RecordField]],
|
||||
* as in the types like `com.digitalasset.ledger.api.v1.value.RecordField`,
|
||||
* and display meaningful information about the field and the container value
|
||||
* when it's not possible because of a `None` value.
|
||||
*
|
||||
@ -20,7 +20,7 @@ import Scalaz._
|
||||
* c: C,
|
||||
* field: String
|
||||
* ): String \/ V = {
|
||||
* optVal.\/>(s"Required field `${field}` is empty in value: ${c}")
|
||||
* optVal.\/>(s"Required field `\$field` is empty in value: \$c")
|
||||
* }
|
||||
* }}}
|
||||
*
|
||||
|
@ -22,7 +22,7 @@ import scalaz.syntax.std.string._
|
||||
*
|
||||
* Therefore, this JSON format can only decode given a target type.
|
||||
*
|
||||
* [[ApiCodecCompressed.apiValueJsonReader]] can create a JSON reader with the necessary type information
|
||||
* `apiValueJsonReader` can create a JSON reader with the necessary type information.
|
||||
*
|
||||
* @param encodeDecimalAsString Not used yet.
|
||||
* @param encodeInt64AsString Not used yet.
|
||||
@ -269,11 +269,11 @@ abstract class ApiCodecCompressed[Cid](
|
||||
jsValueToApiDataType(value, id, dt, defs)
|
||||
}
|
||||
|
||||
/** Creates a [[JsonReader]] for arbitrary [[Model.ApiValue]]s with the relevant type information */
|
||||
/** Creates a JsonReader for Values with the relevant type information */
|
||||
def apiValueJsonReader(typ: DamlLfType, defs: DamlLfTypeLookup): JsonReader[V[Cid]] =
|
||||
jsValueToApiValue(_, typ, defs)
|
||||
|
||||
/** Creates a [[JsonReader]] for arbitrary [[Model.ApiValue]]s with the relevant type information */
|
||||
/** Creates a JsonReader for Values with the relevant type information */
|
||||
def apiValueJsonReader(typ: DamlLfIdentifier, defs: DamlLfTypeLookup): JsonReader[V[Cid]] =
|
||||
jsValueToApiValue(_, typ, defs)
|
||||
|
||||
|
@ -15,7 +15,7 @@ sealed trait Read[To] {
|
||||
/**
|
||||
* Convert `from` to a value of type `To`
|
||||
*
|
||||
* @return [[Right]] wrapping an instance of `To` in case of success in reading, a [[Left]] wrapping a `ReadFailed`
|
||||
* @return `Right` wrapping an instance of `To` in case of success in reading, a `Left` wrapping a `ReadFailed`
|
||||
* otherwise
|
||||
*/
|
||||
def from(from: String): Either[ReadFailed, To]
|
||||
@ -30,7 +30,7 @@ object Read {
|
||||
override def from(from: String): Either[ReadFailed, To] = f(from)
|
||||
}
|
||||
|
||||
/** A failure while reading that wraps the failure inside a [[Left]] */
|
||||
/** A failure while reading that wraps the failure inside a `Left` */
|
||||
def fail[To](implicit classTag: ClassTag[To]): Either[ReadFailed, To] =
|
||||
Left(ReadFailed(classTag.runtimeClass.getSimpleName))
|
||||
|
||||
|
@ -11,7 +11,7 @@ import scala.util.Try
|
||||
/**
|
||||
* Custom marshallers and unmarshallers for dealing with raw JSON values.
|
||||
*
|
||||
* The declared implicit objects replace the ones you would usually import from [[sangria.marshalling.sprayJson]].
|
||||
* The declared implicit objects replace the ones you would usually import from `sangria.marshalling.sprayJson`.
|
||||
* In fact they are largely identical to those except for the additional support for non-scalar JSON values.
|
||||
*
|
||||
* The entire object is only relevant as long as we use raw JSON values in the model.
|
||||
|
@ -25,28 +25,28 @@ case object ActorUnresponsive extends ActorStatus
|
||||
|
||||
object Store {
|
||||
|
||||
/** Reinitialize the platform connection and reset all local state [[Unit]] */
|
||||
/** Reinitialize the platform connection and reset all local state `Unit` */
|
||||
case object ResetConnection
|
||||
|
||||
/** Request to subscribe a party to the store (without response to sender). */
|
||||
case class Subscribe(party: PartyState)
|
||||
|
||||
/** Request to create a contract instance for a template and respond with a [[scala.util.Try[CommandId]*]]. */
|
||||
/** Request to create a contract instance for a template and respond with a `scala.util.Try[CommandId]`. */
|
||||
case class CreateContract(party: PartyState, templateId: TemplateStringId, argument: ApiRecord)
|
||||
|
||||
/** Request to exercise a choice on a contract and respond with a [[scala.util.Try[CommandId]*]]. */
|
||||
/** Request to exercise a choice on a contract and respond with a `scala.util.Try[CommandId]`. */
|
||||
case class ExerciseChoice(
|
||||
party: PartyState,
|
||||
contractId: ApiTypes.ContractId,
|
||||
choiceId: ApiTypes.Choice,
|
||||
argument: ApiValue)
|
||||
|
||||
/** Request to respond with a [[scala.util.Try[TimeProviderWithType]*]] with the current store time. */
|
||||
/** Request to respond with a `scala.util.Try[TimeProviderWithType]` with the current store time. */
|
||||
case object ReportCurrentTime
|
||||
|
||||
/**
|
||||
* Request to advance time to the specified instant and respond with updated store time as a
|
||||
* [[scala.util.Try[TimeProviderWithType]*]].
|
||||
* `scala.util.Try[TimeProviderWithType]`.
|
||||
*/
|
||||
case class AdvanceTime(to: Instant)
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user