package odoc

You can search for identifiers within the package.

in-package search v0.2.0

odoc.document
- Odoc_document
  - Codefmt
    
    Infix
  - Comment
    
    Reference
  - Compat
    
    Format
  - Doctree
    
    Headings
    
    Labels
    
    Math
    
    PageTitle
    
    Rewire
    
    Shift
    
    Subpages
    
    Take
    
    Toc
  - Generator
    
    Make
    
    Syntax
    
    Class
    
    Comment
    
    Mod
    
    Obj
    
    Type
    
    Exception
    
    External
    
    GADT
    
    Record
    
    Tuple
    
    Variant
    
    Value
  - Generator_signatures
    
    GENERATOR
    
    SYNTAX
    
    Class
    
    Comment
    
    Mod
    
    Obj
    
    Type
    
    Exception
    
    External
    
    GADT
    
    Record
    
    Tuple
    
    Variant
    
    Value
  - ML
  - Reason
  - Renderer
  - Targets
  - Types
    
    Alternative
    
    Asset
    
    Block
    
    Class
    
    Description
    
    Document
    
    DocumentedSrc
    
    Heading
    
    Include
    
    Inline
    
    InternalLink
    
    Item
    
    Math
    
    Page
    
    Raw_markup
    
    Source
    
    Source_page
    
    Subpage
    
    Table
  - Url
    
    Anchor
    
    Error
    
    Path
  - Utils
odoc.examples
- Odoc_examples
  - Expansion
    
    Aliases
    
    Alias
    
    DeepEquality
    
    M
    
    X
    
    Y
    
    MODTYPE
    
    X
    
    Y
    
    SIG
    
    DeepEquality2
    
    M
    
    X
    
    Y
    
    MODTYPE
    
    X
    
    Y
    
    Functors
    
    Argument
    
    Functor
    
    X
    
    Y
    
    Result
    
    Include
    
    A
    
    B
    
    ToBeIncluded
    
    ModuleTypeAliases
    
    A
    
    ModuleTypeAliases2
    
    A
    
    A
    
    X
    
    B
    
    ModuleTypeOf
    
    A
    
    M
    
    M'
    
    ModuleTypeOfComplications
    
    S
    
    X
    
    Y
    
    Z
    
    T
    
    Y
    
    Z
    
    X1
    
    Shadowing
    
    A
    
    B
    
    Simple
    
    StringSet
    
    TypeSubstitution
    
    S
    
    M
    
    T
    
    M
  - Markup
    
    Foo
    
    Foo
    
    cl
    
    my_class
    
    my_class_type
    
    my_module_type
    
    M
    
    Preamble_examples
    
    Module
    
    Module2
    
    Nonhidden_module
    
    Nonhidden_module2
    
    Scope
    
    A
    
    Stop
    
    foo
  - Resolution
    
    Alias
    
    A
    
    Canonical
    
    A
    
    B
    
    Complicated_1
    
    A
    
    M
    
    B
    
    S
    
    C
    
    N
    
    Complicated_2
    
    Bar
    
    T
    
    Foo
    
    T
    
    FooBarInt
    
    Foo
    
    Type
    
    Fragments
    
    A
    
    B
    
    C
    
    B
    
    D
    
    Hidden
    
    HiddenAlias
    
    B
    
    References
    
    A
    
    B
  - Wrapping
odoc.html
- Odoc_html
  - Config
  - Generator
  - Html_fragment_json
  - Html_page
  - Json
  - Link
    
    Path
  - Types
odoc.html_support_files
- Odoc_html_support_files
  - Internal
odoc.json_index
- Odoc_json_index
  - Json_display
  - Json_search
odoc.latex
- Odoc_latex
  - Generator
    
    Link
  - Raw
    
    Escape
  - Types
odoc.loader
- Odoc_loader
odoc.manpage
- Odoc_manpage
  - Generator
  - Link
odoc.model
- Odoc_model
  - Comment
  - Compat
  - Error
  - Fold
  - Lang
    
    Class
    
    ClassSignature
    
    Constraint
    
    Inherit
    
    ClassType
    
    Compilation_unit
    
    Import
    
    Packed
    
    Source
    
    Exception
    
    Extension
    
    Constructor
    
    FunctorParameter
    
    Include
    
    InstanceVariable
    
    Method
    
    Module
    
    Equation
    
    ModuleSubstitution
    
    ModuleType
    
    U
    
    ModuleTypeSubstitution
    
    Open
    
    Page
    
    Signature
    
    SourceTree
    
    Source_info
    
    TypeDecl
    
    Constructor
    
    Equation
    
    Field
    
    Representation
    
    TypeExpr
    
    Object
    
    Package
    
    Polymorphic_variant
    
    Constructor
    
    Value
  - Location_
  - Names
    
    ClassName
    
    ClassTypeName
    
    ConstructorName
    
    DefName
    
    ExceptionName
    
    ExtensionName
    
    FieldName
    
    InstanceVariableName
    
    LabelName
    
    LocalName
    
    MethodName
    
    ModuleName
    
    ModuleTypeName
    
    Name
    
    PageName
    
    SimpleName
    
    TypeName
    
    ValueName
  - Paths
    
    Fragment
    
    Module
    
    ModuleType
    
    Resolved
    
    Module
    
    ModuleType
    
    Signature
    
    Type
    
    Signature
    
    Type
    
    Identifier
    
    Any
    
    AssetFile
    
    Class
    
    ClassSignature
    
    ClassType
    
    Constructor
    
    ContainerPage
    
    DataType
    
    Exception
    
    Extension
    
    ExtensionDecl
    
    Field
    
    FieldParent
    
    FunctorParameter
    
    FunctorResult
    
    Id
    
    IdSig
    
    InstanceVariable
    
    Label
    
    LabelParent
    
    Maps
    
    Any
    
    Class
    
    ClassType
    
    FunctorParameter
    
    Label
    
    Module
    
    ModuleType
    
    Path
    
    ClassType
    
    Type
    
    Type
    
    Method
    
    Mk
    
    Module
    
    ModuleType
    
    NonSrc
    
    OdocId
    
    Page
    
    Path
    
    ClassType
    
    Constructor
    
    DataType
    
    Module
    
    ModuleType
    
    Type
    
    Value
    
    RootModule
    
    Signature
    
    SourceDir
    
    SourceLocation
    
    SourcePage
    
    Type
    
    Value
    
    Path
    
    ClassType
    
    Constructor
    
    DataType
    
    Module
    
    ModuleType
    
    Resolved
    
    ClassType
    
    Constructor
    
    DataType
    
    Module
    
    ModuleType
    
    Type
    
    Value
    
    Type
    
    Value
    
    Reference
    
    Class
    
    ClassSignature
    
    ClassType
    
    Constructor
    
    DataType
    
    Exception
    
    Extension
    
    ExtensionDecl
    
    Field
    
    FragmentTypeParent
    
    InstanceVariable
    
    Label
    
    LabelParent
    
    Method
    
    Module
    
    ModuleType
    
    Page
    
    Resolved
    
    Class
    
    ClassSignature
    
    ClassType
    
    Constructor
    
    DataType
    
    Exception
    
    Extension
    
    ExtensionDecl
    
    Field
    
    FieldParent
    
    InstanceVariable
    
    Label
    
    LabelParent
    
    Method
    
    Module
    
    ModuleType
    
    Page
    
    Signature
    
    Type
    
    Value
    
    Signature
    
    Type
    
    Value
  - Predefined
  - Root
    
    Hash_table
    
    Odoc_file
    
    Package
  - Semantics
odoc.model_desc
- Odoc_model_desc
odoc.odoc
- Odoc_odoc
  - Compile
  - Depends
    
    Compile
  - Fs
    
    Directory
    
    Table
    
    File
    
    Table
  - Html_fragment
  - Html_page
    
    Source
  - Indexing
  - Latex
  - Man_page
  - Odoc_file
  - Odoc_link
  - Or_error
  - Rendering
  - Resolver
  - Source_tree
  - Support_files
  - Url
odoc.search
- Odoc_search
  - Entry
  - Html
  - Text
odoc.search_html_frontend
- Odoc_html_frontend
odoc.syntax_highlighter
- Syntax_highlighter
odoc.xref2
- Odoc_xref2
  - Cfrag
  - Compile
  - Component
    
    CComment
    
    Class
    
    ClassSignature
    
    Constraint
    
    Inherit
    
    ClassType
    
    Delayed
    
    Element
    
    Exception
    
    Extension
    
    Constructor
    
    Fmt
    
    FunctorParameter
    
    IdentMap
    
    Include
    
    InstanceVariable
    
    Label
    
    Method
    
    Module
    
    ModuleMap
    
    ModuleSubstitution
    
    ModuleType
    
    U
    
    ModuleTypeMap
    
    ModuleTypeSubstitution
    
    Of_Lang
    
    Open
    
    Opt
    
    PathClassTypeMap
    
    PathModuleMap
    
    PathTypeMap
    
    PathValueMap
    
    Signature
    
    Substitution
    
    TypeDecl
    
    Constructor
    
    Equation
    
    Field
    
    Representation
    
    TypeExpr
    
    Object
    
    Package
    
    Polymorphic_variant
    
    Constructor
    
    TypeMap
    
    Value
  - Cpath
    
    Cpath
    
    Resolved
  - Env
    
    LookupTypeSet
  - Errors
    
    Tools_error
  - Expand_tools
  - Find
  - Ident
    
    Maps
    
    Module
    
    ModuleType
    
    Type
    
    Name
    
    Of_Identifier
    
    Rename
  - Lang_of
    
    Path
  - Link
  - Lookup_failures
  - Ref_tools
  - Shape_tools
  - Strengthen
  - Subst
  - Tools
  - Type_of
  - Utils
    
    EitherMonad
    
    OptionMonad
    
    ResultMonad
odoc.xref_test
- Odoc_xref_test
  - Common
    
    LangUtils
    
    Fmt
    
    Lens
    
    FunctorParameter
    
    Include
    
    Module
    
    ModuleType
    
    Signature
    
    TypeDecl
    
    Equation
    
    TypeExpr
    
    Lookup

Legend:
Library
Module
Module type
Parameter
Class
Class type

Markup examples.

The OCaml manual gives a comprehensive example of comment placement. This has been replicated in the module Foo below to show how this is rendered by odoc.

module type Foo = sig ... end

The first special comment of the file is the comment associated with the whole module.

module Stop : sig ... end

This module demonstrates the use of stop comments ((**/**))

module Scope : sig ... end

module Preamble_examples : sig ... end

This module demonstrates the various ways that preambles are calculated