KC's Workspace
    Preparing search index...

    A group of reflections. All reflections in a group are of the same kind.

    Reflection groups are created by the ´GroupHandler´ in the resolving phase of the dispatcher. The main purpose of groups is to be able to more easily render human readable children lists in templates.

    Index

    Constructors

    • Create a new ReflectionGroup instance.

      Parameters

      • title: string

        The title of this group.

      • owningReflection: Reflection

        The reflection containing this group, useful for changing rendering based on a comment on a reflection.

      Returns ReflectionGroup

    Properties

    categories?: ReflectionCategory[]

    Categories contained within this group.

    All reflections of this group.

    description?: CommentDisplayPart[]

    User specified description via @groupDescription, if specified.

    owningReflection: Reflection
    title: string

    The title, a string representation of the typescript kind, of this group.

    Methods