jon.recoil.org

Module Paths.ReferenceSource

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

Sourcemodule Resolved : sig ... end
Sourcemodule Signature : sig ... end
Sourcemodule ClassSignature : sig ... end
Sourcemodule DataType : sig ... end
Sourcemodule FragmentTypeParent : sig ... end
Sourcemodule LabelParent : sig ... end
Sourcemodule Module : sig ... end
Sourcemodule ModuleType : sig ... end
Sourcemodule Type : sig ... end
Sourcemodule Constructor : sig ... end
Sourcemodule Field : sig ... end
Sourcemodule UnboxedField : sig ... end
Sourcemodule Extension : sig ... end
Sourcemodule ExtensionDecl : sig ... end
Sourcemodule Exception : sig ... end
Sourcemodule Value : sig ... end
Sourcemodule Class : sig ... end
Sourcemodule ClassType : sig ... end
Sourcemodule Method : sig ... end
Sourcemodule InstanceVariable : sig ... end
Sourcemodule Label : sig ... end
Sourcemodule Page : sig ... end
Sourcemodule Asset : sig ... end
Sourcemodule Hierarchy : sig ... end
Sourcetype t = [
  1. | `Resolved of Odoc_model.Paths.Reference.Resolved.t
  2. | `Root of string * Odoc_model.Paths.Reference.tag_any
  3. | `Dot of Odoc_model.Paths.Reference.LabelParent.t * string
  4. | `Page_path of Odoc_model.Paths.Reference.Hierarchy.t
  5. | `Module_path of Odoc_model.Paths.Reference.Hierarchy.t
  6. | `Asset_path of Odoc_model.Paths.Reference.Hierarchy.t
  7. | `Any_path of Odoc_model.Paths.Reference.Hierarchy.t
  8. | `Module of Odoc_model.Paths.Reference.Signature.t * Odoc_model.Names.ModuleName.t
  9. | `ModuleType of Odoc_model.Paths.Reference.Signature.t * Odoc_model.Names.ModuleTypeName.t
  10. | `Type of Odoc_model.Paths.Reference.Signature.t * Odoc_model.Names.TypeName.t
  11. | `Constructor of Odoc_model.Paths.Reference.FragmentTypeParent.t * Odoc_model.Names.ConstructorName.t
  12. | `Field of Odoc_model.Paths.Reference.FragmentTypeParent.t * Odoc_model.Names.FieldName.t
  13. | `UnboxedField of Odoc_model.Paths.Reference.FragmentTypeParent.t * Odoc_model.Names.UnboxedFieldName.t
  14. | `Extension of Odoc_model.Paths.Reference.Signature.t * Odoc_model.Names.ExtensionName.t
  15. | `ExtensionDecl of Odoc_model.Paths.Reference.Signature.t * Odoc_model.Names.ExtensionName.t
  16. | `Exception of Odoc_model.Paths.Reference.Signature.t * Odoc_model.Names.ExceptionName.t
  17. | `Value of Odoc_model.Paths.Reference.Signature.t * Odoc_model.Names.ValueName.t
  18. | `Class of Odoc_model.Paths.Reference.Signature.t * Odoc_model.Names.TypeName.t
  19. | `ClassType of Odoc_model.Paths.Reference.Signature.t * Odoc_model.Names.TypeName.t
  20. | `Method of Odoc_model.Paths.Reference.ClassSignature.t * Odoc_model.Names.MethodName.t
  21. | `InstanceVariable of Odoc_model.Paths.Reference.ClassSignature.t * Odoc_model.Names.InstanceVariableName.t
  22. | `Label of Odoc_model.Paths.Reference.LabelParent.t * Odoc_model.Names.LabelName.t
]
Sourcetype tag_any = [
  1. | `TModule
  2. | `TModuleType
  3. | `TType
  4. | `TConstructor
  5. | `TField
  6. | `TUnboxedField
  7. | `TExtension
  8. | `TExtensionDecl
  9. | `TException
  10. | `TValue
  11. | `TClass
  12. | `TClassType
  13. | `TMethod
  14. | `TInstanceVariable
  15. | `TLabel
  16. | `TPage
  17. | `TAsset
  18. | `TChildPage
  19. | `TChildModule
  20. | `TUnknown
]
Sourcetype tag_hierarchy = [
  1. | `TRelativePath
    (*

    {!identifier/}

    *)
  2. | `TAbsolutePath
    (*

    {!/identifier}

    *)
  3. | `TCurrentPackage
    (*

    {!//identifier}

    *)
]