Class ReflectionGroup

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.

Constructors

Properties

All reflections of this group.

owningReflection: Models.Reflection

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

title: string

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

categories?: Models.ReflectionCategory[]

Categories contained within this group.

description?: Models.CommentDisplayPart[]

User specified description via @groupDescription, if specified.

Methods

  • Do all children of this group have a separate document?

    Returns boolean