Up – OCaml package documentation » The odoc documentation generator » Library odoc.model » Odoc_model » Paths » Reference

Module `Paths.Reference`

References present in documentation comments ({!Foo.Bar})

module Resolved : sig ... end

module Signature : sig ... end

module ClassSignature : sig ... end

module DataType : sig ... end

module FragmentTypeParent : sig ... end

module LabelParent : sig ... end

module Module : sig ... end

module ModuleType : sig ... end

module Type : sig ... end

module Constructor : sig ... end

module Field : sig ... end

module UnboxedField : sig ... end

module Extension : sig ... end

module ExtensionDecl : sig ... end

module Exception : sig ... end

module Value : sig ... end

module Class : sig ... end

module ClassType : sig ... end

module Method : sig ... end

module InstanceVariable : sig ... end

module Label : sig ... end

module Page : sig ... end

module Asset : sig ... end

module Hierarchy : sig ... end

type t = [

| `Resolved of Resolved.t
| `Root of string * tag_any
| `Dot of LabelParent.t * string
| `Page_path of Hierarchy.t
| `Module_path of Hierarchy.t
| `Asset_path of Hierarchy.t
| `Any_path of Hierarchy.t
| `Module of Signature.t * Names.ModuleName.t
| `ModuleType of Signature.t * Names.ModuleTypeName.t
| `Type of Signature.t * Names.TypeName.t
| `Constructor of FragmentTypeParent.t * Names.ConstructorName.t
| `Field of FragmentTypeParent.t * Names.FieldName.t
| `UnboxedField of FragmentTypeParent.t * Names.UnboxedFieldName.t
| `Extension of Signature.t * Names.ExtensionName.t
| `ExtensionDecl of Signature.t * Names.ExtensionName.t
| `Exception of Signature.t * Names.ExceptionName.t
| `Value of Signature.t * Names.ValueName.t
| `Class of Signature.t * Names.TypeName.t
| `ClassType of Signature.t * Names.TypeName.t
| `Method of ClassSignature.t * Names.MethodName.t
| `InstanceVariable of ClassSignature.t * Names.InstanceVariableName.t
| `Label of LabelParent.t * Names.LabelName.t

]

type tag_any = [

| `TModule
| `TModuleType
| `TType
| `TConstructor
| `TField
| `TUnboxedField
| `TExtension
| `TExtensionDecl
| `TException
| `TValue
| `TClass
| `TClassType
| `TMethod
| `TInstanceVariable
| `TLabel
| `TPage
| `TAsset
| `TChildPage
| `TChildModule
| `TUnknown

]

type tag_hierarchy = [

| `TRelativePath
(*
{!identifier/}
*)
| `TAbsolutePath
(*
{!/identifier}
*)
| `TCurrentPackage
(*
{!//identifier}
*)

]