package odoc

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Resolving
Expansion
Misc.

package odoc

odoc.compat
- Odoc_compat
  - Char
  - String
odoc.html
- Odoc_html
  - Comment
  - Generator
    
    ML
    
    Reason
  - Targets
  - Tree
    
    Relative_link
    
    Id
  - Url
    
    Anchor
    
    Module_listing
    
    Polymorphic_variant_decl
    
    Error
odoc.loader
- Odoc_loader
odoc.model
- Odoc_model
  - Comment
  - Compat
  - Error
  - Ident_env
    
    Fragment
    
    Path
  - Lang
    
    Class
    
    ClassSignature
    
    ClassType
    
    Compilation_unit
    
    Import
    
    Packed
    
    Source
    
    Exception
    
    Extension
    
    Constructor
    
    External
    
    FunctorParameter
    
    Include
    
    InstanceVariable
    
    Method
    
    Module
    
    Equation
    
    ModuleSubstitution
    
    ModuleType
    
    Page
    
    Signature
    
    TypeDecl
    
    Constructor
    
    Equation
    
    Field
    
    Representation
    
    TypeExpr
    
    Object
    
    Package
    
    Polymorphic_variant
    
    Constructor
    
    Value
  - Location_
  - Maps
    
    class_
    
    class_signature
    
    class_type
    
    documentation
    
    exception_
    
    extension
    
    external_
    
    fragment
    
    identifier
    
    include_
    
    instance_variable
    
    method_
    
    module_
    
    module_substitution
    
    module_type
    
    page
    
    path
    
    paths
    
    reference
    
    signature
    
    type_decl
    
    type_expr
    
    types
    
    unit
    
    value
  - Names
    
    ArgumentName
    
    ClassName
    
    ClassTypeName
    
    ConstructorName
    
    ExceptionName
    
    ExtensionName
    
    FieldName
    
    InstanceVariableName
    
    LabelName
    
    MethodName
    
    ModuleName
    
    ModuleTypeName
    
    Name
    
    PageName
    
    SimpleName
    
    TypeName
    
    UnitName
    
    ValueName
  - Paths
    
    Fragment
    
    Module
    
    Resolved
    
    Module
    
    Signature
    
    Type
    
    Signature
    
    Type
    
    Identifier
    
    Class
    
    ClassSignature
    
    ClassType
    
    Constructor
    
    DataType
    
    Exception
    
    Extension
    
    Field
    
    InstanceVariable
    
    Label
    
    LabelParent
    
    Method
    
    Module
    
    ModuleType
    
    Page
    
    Parent
    
    Path
    
    ClassType
    
    Module
    
    ModuleType
    
    Type
    
    Signature
    
    Type
    
    Value
    
    Path
    
    ClassType
    
    Module
    
    ModuleType
    
    Resolved
    
    ClassType
    
    Module
    
    ModuleType
    
    Type
    
    Type
    
    Reference
    
    Class
    
    ClassSignature
    
    ClassType
    
    Constructor
    
    DataType
    
    Exception
    
    Extension
    
    Field
    
    InstanceVariable
    
    Label
    
    LabelParent
    
    Method
    
    Module
    
    ModuleType
    
    Page
    
    Parent
    
    Resolved
    
    Class
    
    ClassSignature
    
    ClassType
    
    Constructor
    
    DataType
    
    Exception
    
    Extension
    
    Field
    
    InstanceVariable
    
    Label
    
    LabelParent
    
    Method
    
    Module
    
    ModuleType
    
    Page
    
    Parent
    
    Signature
    
    Type
    
    Value
    
    Signature
    
    Type
    
    Value
  - Paths_types
    
    Fragment
    
    Identifier
    
    Path
    
    Reference
    
    Resolved_fragment
    
    Resolved_path
    
    Resolved_reference
  - Predefined
  - Root
    
    Hash_table
    
    Odoc_file
    
    Package
odoc.odoc
- Odoc_odoc
  - Compilation_unit
  - Compile
  - Css_file
  - Depends
    
    Compile
  - Env
  - Fs
    
    Directory
    
    Table
    
    File
    
    Table
  - Highlight_js
  - Html_fragment
  - Html_page
  - Or_error
  - Page
  - Root
  - Support_files
  - Targets
odoc.parser
- Odoc_parser
  - Ast
odoc.xref
- Odoc_xref
  - Lookup

Legend:
Library
Module
Module type
Parameter
Class
Class type

Resolving

This is the part of DocOck handling the resolving of path and references.

type resolver

type lookup_result_found = {

root : Odoc_model.Root.t;
hidden : bool;

}

type lookup_result =

| Forward_reference
| Found of lookup_result_found
| Not_found

type msg = [

| `Msg of string

]

val build_resolver : 
  ?equal:(Odoc_model.Root.t -> Odoc_model.Root.t -> bool) ->
  ?hash:(Odoc_model.Root.t -> int) ->
  (string -> lookup_result) ->
  (Odoc_model.Root.t ->
    (Odoc_model.Lang.Compilation_unit.t, msg) Result.result) ->
  (string -> Odoc_model.Root.t option) ->
  (Odoc_model.Root.t -> (Odoc_model.Lang.Page.t, msg) Result.result) ->
  resolver

Build a resolver. Optionally provide equality and hash on 'a.

val resolve : 
  resolver ->
  Odoc_model.Lang.Compilation_unit.t ->
  (Odoc_model.Lang.Compilation_unit.t, [> msg ]) Result.result

val resolve_page : 
  resolver ->
  Odoc_model.Lang.Page.t ->
  (Odoc_model.Lang.Page.t, [> msg ]) Result.result

Expansion

This is the part of DocOck in charge of performing substitutions, inlining of includes, etc.

type expander

val build_expander : 
  ?equal:(Odoc_model.Root.t -> Odoc_model.Root.t -> bool) ->
  ?hash:(Odoc_model.Root.t -> int) ->
  (string -> lookup_result) ->
  (root:Odoc_model.Root.t ->
    Odoc_model.Root.t ->
    (Odoc_model.Lang.Compilation_unit.t, msg) Result.result) ->
  expander

Build an expander. Assumes that it is safe to use Hashtbl.hash and structural equality (=) on 'a.

val expand : 
  expander ->
  Odoc_model.Lang.Compilation_unit.t ->
  (Odoc_model.Lang.Compilation_unit.t, [> msg ]) Result.result

Misc.

OCaml's predefined types and exceptions.

val core_types : Odoc_model.Lang.TypeDecl.t list

val core_exceptions : Odoc_model.Lang.Exception.t list

module Lookup : sig ... end