package doc-ock

Every path is annotated with its kind.

General purpose kinds

Identifier kinds

The kind of an identifier directly corresponds to the kind of its referent.

Path kinds

There are four kinds of OCaml path:

• module
• module type
• type
• class type

These kinds do not directly correspond to the kind of their referent (e.g. a type path may refer to a class definition).

Fragment kinds

There are two kinds of OCaml path fragment:

• module
• type

These kinds do not directly correspond to the kind of their referent (e.g. a type path fragment may refer to a class definition).

Reference kinds

There is one reference kind for each kind of referent. However, the kind of a reference does not refer to the kind of its referent, but to the kind with which the reference was annotated.

This means that reference kinds do not correspond directly to the kind of their referent because we used more relaxed rules when resolving a reference. For example, a reference annotated as being to a constructor can be resolved to the definition of an exception (which is a sort of constructor).