cpdocs API documentation
Project documentation Docs

Role Python

Defined in kinds.py

class Role(enum.Flag)

What a kind is, as far as page layout is concerned.

`CONTAINER kinds, such as namespaces and modules, get a page listing their members. TYPE_PAGE kinds get a page of their own with their members grouped under headings, and CLASS_LIKE kinds among them can have bases and specializations. TYPE kinds name types and are linked from declarations. CALLABLE kinds have signatures, one card per overload. VALUE` kinds are data members, shown with their type and value.

Available in feature sets

Public Members

CCALLABLE = enum.auto()
CCLASS_LIKE = enum.auto()
CCONTAINER = enum.auto()
CNONE = 0
CTYPE = enum.auto()
CTYPE_PAGE = enum.auto()
CVALUE = enum.auto()