TypeDescriber.describe

Describe a component based on it's identity and itself using generic identity and type formatter in title and description templates.

  1. Optional!(const(Description!IdentityType)) describe(IdentityType identity, ComponentType component)
    class TypeDescriber(ComponentType = Object, IdentityType = string)
    const @safe
    Optional!(const(Description!IdentityType))
    describe
    (
    const ref IdentityType identity
    ,
    const ref ComponentType component
    )
  2. alias describe = Describer!(ComponentType, IdentityType).describe

Parameters

identity IdentityType

identity of component being described

component ComponentType

component that is described

Return Value

Type: Optional!(const(Description!IdentityType))

A description or empty if it is not describable by this describer

Meta