package odoc

You can search for identifiers within the package.

in-package search v0.2.0

odoc
- CHANGES
- LICENSE
- README
- Contributing to odoc
- Hows does odoc work?
- Understanding odoc Internals
- Build System Integration
- Using odoc
- Library odoc.compat
  - Odoc_compat
    
    String
    
    Char
- Library odoc.html
  - Odoc_html
    
    Tree
    
    Html
    
    Paths
    
    Relative_link
    
    Id
    
    Comment
    
    Html
    
    Targets
    
    Generator
    
    ML
    
    Reason
    
    Url
    
    Error
    
    Anchor
    
    Polymorphic_variant_decl
    
    Module_listing
- Library odoc.loader
  - Odoc_loader
- Library odoc.model
  - Odoc_model
    
    Comment
    
    Path
    
    Reference
    
    Identifier
    
    Compat
    
    Error
    
    Ident_env
    
    Path
    
    Fragment
    
    Lang
    
    Module
    
    Equation
    
    FunctorParameter
    
    ModuleType
    
    ModuleSubstitution
    
    Signature
    
    Include
    
    TypeDecl
    
    Field
    
    Constructor
    
    Representation
    
    Equation
    
    Extension
    
    Constructor
    
    Exception
    
    Value
    
    External
    
    Class
    
    ClassType
    
    ClassSignature
    
    Method
    
    InstanceVariable
    
    TypeExpr
    
    Polymorphic_variant
    
    Constructor
    
    Object
    
    Package
    
    Compilation_unit
    
    Import
    
    Source
    
    Packed
    
    Page
    
    Location_
    
    Maps
    
    identifier
    
    path
    
    fragment
    
    reference
    
    paths
    
    documentation
    
    module_
    
    module_substitution
    
    module_type
    
    signature
    
    include_
    
    type_decl
    
    extension
    
    exception_
    
    value
    
    external_
    
    class_
    
    class_type
    
    class_signature
    
    method_
    
    instance_variable
    
    type_expr
    
    unit
    
    page
    
    types
    
    Names
    
    Name
    
    SimpleName
    
    ModuleName
    
    ArgumentName
    
    ModuleTypeName
    
    TypeName
    
    ConstructorName
    
    FieldName
    
    ExtensionName
    
    ExceptionName
    
    ValueName
    
    ClassName
    
    ClassTypeName
    
    MethodName
    
    InstanceVariableName
    
    UnitName
    
    LabelName
    
    PageName
    
    Paths
    
    Identifier
    
    Signature
    
    ClassSignature
    
    DataType
    
    Parent
    
    LabelParent
    
    Module
    
    ModuleType
    
    Type
    
    Constructor
    
    Field
    
    Extension
    
    Exception
    
    Value
    
    Class
    
    ClassType
    
    Method
    
    InstanceVariable
    
    Label
    
    Page
    
    Path
    
    Module
    
    ModuleType
    
    Type
    
    ClassType
    
    Path
    
    Resolved
    
    Module
    
    ModuleType
    
    Type
    
    ClassType
    
    Module
    
    ModuleType
    
    Type
    
    ClassType
    
    Fragment
    
    Resolved
    
    Signature
    
    Module
    
    Type
    
    Signature
    
    Module
    
    Type
    
    Reference
    
    Resolved
    
    Signature
    
    ClassSignature
    
    DataType
    
    Parent
    
    LabelParent
    
    Module
    
    ModuleType
    
    Type
    
    Constructor
    
    Field
    
    Extension
    
    Exception
    
    Value
    
    Class
    
    ClassType
    
    Method
    
    InstanceVariable
    
    Label
    
    Page
    
    Signature
    
    ClassSignature
    
    DataType
    
    Parent
    
    LabelParent
    
    Module
    
    ModuleType
    
    Type
    
    Constructor
    
    Field
    
    Extension
    
    Exception
    
    Value
    
    Class
    
    ClassType
    
    Method
    
    InstanceVariable
    
    Label
    
    Page
    
    Paths_types
    
    Identifier
    
    Path
    
    Resolved_path
    
    Fragment
    
    Resolved_fragment
    
    Reference
    
    Resolved_reference
    
    Predefined
    
    Root
    
    Package
    
    Odoc_file
    
    Hash_table
- Library 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
- Library odoc.parser
  - Odoc_parser
    
    Ast
- Library odoc.xref
  - Odoc_xref
    
    Lookup
- Sources
  - odoc.compat
    
    odoc_compat.ml
  - odoc.html
    
    ML.ml
    
    comment.ml
    
    generator.ml
    
    generator_signatures.ml
    
    odoc_html.ml
    
    odoc_html__.ml
    
    reason.ml
    
    targets.ml
    
    tree.ml
    
    url.ml
    
    utils.ml
  - odoc.loader
    
    cmi.ml
    
    cmt.ml
    
    cmti.ml
    
    doc_attr.ml
    
    odoc_loader.ml
    
    odoc_loader__.ml
  - odoc.model
    
    comment.ml
    
    compat.ml
    
    error.ml
    
    ident_env.ml
    
    lang.ml
    
    location_.ml
    
    maps.ml
    
    names.ml
    
    odoc_model.ml
    
    paths.ml
    
    paths_types.ml
    
    predefined.ml
    
    root.ml
  - odoc.odoc
    
    compilation_unit.ml
    
    compile.ml
    
    css_file.ml
    
    depends.ml
    
    env.ml
    
    fs.ml
    
    highlight_js.ml
    
    html_fragment.ml
    
    html_page.ml
    
    odoc_odoc.ml
    
    or_error.ml
    
    page.ml
    
    root.ml
    
    support_files.ml
    
    targets.ml
  - odoc.parser
    
    ast.ml
    
    lexer.ml
    
    odoc_parser.ml
    
    odoc_parser__.ml
    
    parse_error.ml
    
    reference.ml
    
    semantics.ml
    
    syntax.ml
    
    token.ml
  - odoc.xref
    
    component_table.ml
    
    components.ml
    
    expand.ml
    
    lookup.ml
    
    name_env.ml
    
    odoc_xref.ml
    
    odoc_xref__.ml
    
    resolve.ml
    
    subst.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Class `Maps.documentation`

method virtual identifier_label : Odoc_model.Paths.Identifier.Label.t ->
  Odoc_model.Paths.Identifier.Label.t

method virtual identifier : Odoc_model.Paths.Identifier.t ->
  Odoc_model.Paths.Identifier.t

method virtual path_module : Odoc_model.Paths.Path.Module.t ->
  Odoc_model.Paths.Path.Module.t

method virtual reference_module : Odoc_model.Paths.Reference.Module.t ->
  Odoc_model.Paths.Reference.Module.t

method virtual reference_module_type : Odoc_model.Paths.Reference.ModuleType.t ->
  Odoc_model.Paths.Reference.ModuleType.t

method virtual reference_type : Odoc_model.Paths.Reference.Type.t ->
  Odoc_model.Paths.Reference.Type.t

method virtual reference_constructor : Odoc_model.Paths.Reference.Constructor.t ->
  Odoc_model.Paths.Reference.Constructor.t

method virtual reference_field : Odoc_model.Paths.Reference.Field.t ->
  Odoc_model.Paths.Reference.Field.t

method virtual reference_extension : Odoc_model.Paths.Reference.Extension.t ->
  Odoc_model.Paths.Reference.Extension.t

method virtual reference_exception : Odoc_model.Paths.Reference.Exception.t ->
  Odoc_model.Paths.Reference.Exception.t

method virtual reference_value : Odoc_model.Paths.Reference.Value.t ->
  Odoc_model.Paths.Reference.Value.t

method virtual reference_class : Odoc_model.Paths.Reference.Class.t ->
  Odoc_model.Paths.Reference.Class.t

method virtual reference_class_type : Odoc_model.Paths.Reference.ClassType.t ->
  Odoc_model.Paths.Reference.ClassType.t

method virtual reference_method : Odoc_model.Paths.Reference.Method.t ->
  Odoc_model.Paths.Reference.Method.t

method virtual reference_instance_variable : Odoc_model.Paths.Reference.InstanceVariable.t ->
  Odoc_model.Paths.Reference.InstanceVariable.t

method virtual reference_label : Odoc_model.Paths.Reference.Label.t ->
  Odoc_model.Paths.Reference.Label.t

method virtual reference_any : Odoc_model.Paths.Reference.t ->
  Odoc_model.Paths.Reference.t

method documentation_reference : (Odoc_model.Paths.Reference.t
                                  * Odoc_model.Comment.link_content) ->
  Odoc_model.Paths.Reference.t * Odoc_model.Comment.link_content

method documentation : Odoc_model.Comment.docs -> Odoc_model.Comment.docs

method documentation_comment : Odoc_model.Comment.docs_or_stop ->
  Odoc_model.Comment.docs_or_stop

package odoc

Class Maps.documentation

Class `Maps.documentation`