doc-ock 1.2.1 · OCaml Package

doc-ock

package doc-ock

doc-ock
- DocOck
- DocOckAttrs
- DocOckCmi
- DocOckCmt
- DocOckCmti
- DocOckComponentTbl
- DocOckComponents
  - ClassSig
  - Datatype
  - Element
  - Page
  - Parent
  - Sig
- DocOckExpand
- DocOckIdentEnv
  - Fragment
  - Path
- DocOckLookup
- DocOckMaps
  - class_
  - class_signature
  - class_type
  - documentation
  - exception_
  - extension
  - external_
  - fragment
  - identifier
  - include_
  - instance_variable
  - method_
  - module_
  - module_type
  - page
  - path
  - paths
  - reference
  - signature
  - type_decl
  - type_expr
  - types
  - unit
  - value
- DocOckNameEnv
- DocOckPaths
  - Fragment
    
    Resolved
  - Identifier
  - Kind
  - Path
    
    Resolved
  - Reference
    
    Resolved
- DocOckPayload
- DocOckPredef
- DocOckResolve
- DocOckSubst
- DocOckTypes
  - Class
  - ClassSignature
  - ClassType
  - Documentation
    
    Error
    
    Location
    
    Offset
    
    Position
  - Exception
  - Extension
    
    Constructor
  - External
  - FunctorArgument
  - Include
  - InstanceVariable
  - Method
  - Module
    
    Equation
  - ModuleType
  - Page
  - Signature
  - TypeDecl
    
    Constructor
    
    Equation
    
    Field
    
    Representation
  - TypeExpr
    
    Object
    
    Package
    
    Variant
  - Unit
    
    Import
    
    Packed
    
    Source
  - Value
doc-ock.ocamlary
- Ocamlary
  - A
    
    Q
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
  - Aliases
    
    E
    
    Foo
    
    A
    
    B
    
    C
    
    D
    
    E
    
    P1
    
    Y
    
    P2
    
    Z
    
    Std
  - B
    
    Q
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
  - Buffer
  - C
    
    Q
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
  - COLLECTION
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
  - CanonicalTest
    
    Base
    
    List
    
    List_modif
  - CollectionModule
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
  - Dep1
    
    S
    
    c
    
    X
    
    Y
    
    c
  - Dep10
  - Dep11
    
    S
    
    c
  - Dep12
    
    Arg
  - Dep13
    
    c
  - Dep2
    
    A
    
    Arg
    
    X
  - Dep3
  - Dep4
    
    S
    
    X
    
    Y
    
    T
    
    X
  - Dep5
    
    Arg
    
    S
    
    Y
    
    Z
  - Dep6
    
    S
    
    T
    
    Y
    
    X
    
    Y
  - Dep7
    
    Arg
    
    T
    
    X
    
    M
  - Dep8
    
    T
  - Dep9
    
    X
  - DoubleInclude1
    
    DoubleInclude2
  - DoubleInclude3
    
    DoubleInclude2
  - Empty
  - EmptySig
  - ExtMod
  - FunctorTypeOf
    
    Collection
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
  - IncludeInclude1
    
    IncludeInclude2
  - IncludeInclude2
  - IncludeModuleType
  - IncludedA
  - IncludedB
  - M
  - MMM
    
    C
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
  - MissingComment
  - ModuleWithSignature
  - ModuleWithSignatureAlias
  - NestedInclude1
    
    NestedInclude2
  - NestedInclude2
  - One
  - Only_a_module
  - RECOLLECTION
  - Recollection
    
    C
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
  - RecollectionModule
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
  - SigForMod
    
    Inner
    
    Empty
  - SuperSig
    
    EmptySig
    
    One
    
    SubSigA
    
    SubSigAMod
    
    SubSigB
    
    SuperSig
  - ToInclude
    
    IncludedA
    
    IncludedB
  - With1
    
    M
  - With10
    
    T
    
    M
  - With11
    
    N
  - With2
    
    S
  - With3
    
    N
  - With4
    
    N
  - With5
    
    N
    
    S
  - With6
    
    T
    
    M
  - With7
    
    X
  - With8
    
    M
    
    N
  - With9
    
    S
  - empty_class
  - one_method_class
  - param_class
  - two_method_class

Legend:
Library
Module
Module type
Parameter
Class
Class type

method virtual identifier_type : 'a DocOckPaths.Identifier.type_ ->
  'a DocOckPaths.Identifier.type_

method virtual identifier_constructor : 'a DocOckPaths.Identifier.constructor ->
  'a DocOckPaths.Identifier.constructor

method virtual identifier_field : 'a DocOckPaths.Identifier.field ->
  'a DocOckPaths.Identifier.field

method virtual documentation : 'a DocOckTypes.Documentation.t ->
  'a DocOckTypes.Documentation.t

method virtual type_expr : 'a DocOckTypes.TypeExpr.t ->
  'a DocOckTypes.TypeExpr.t

method type_decl_constructor : 'a DocOckTypes.TypeDecl.Constructor.t ->
  'a DocOckTypes.TypeDecl.Constructor.t

method type_decl_constructor_argument : 'a
                                          DocOckTypes.TypeDecl.Constructor.argument ->
  'a DocOckTypes.TypeDecl.Constructor.argument

method type_decl_field : 'a DocOckTypes.TypeDecl.Field.t ->
  'a DocOckTypes.TypeDecl.Field.t

method type_decl_field_mutable : bool -> bool

method type_decl_representation : 'a DocOckTypes.TypeDecl.Representation.t ->
  'a DocOckTypes.TypeDecl.Representation.t

method type_decl_variance : DocOckTypes.TypeDecl.variance ->
  DocOckTypes.TypeDecl.variance

method type_decl_param_desc : DocOckTypes.TypeDecl.param_desc ->
  DocOckTypes.TypeDecl.param_desc

method type_decl_param_name : string -> string

method type_decl_param : DocOckTypes.TypeDecl.param ->
  DocOckTypes.TypeDecl.param

method type_decl_equation : 'a DocOckTypes.TypeDecl.Equation.t ->
  'a DocOckTypes.TypeDecl.Equation.t

method type_decl_private : bool -> bool

method type_decl_constraint : ('a DocOckTypes.TypeExpr.t
                               * 'a DocOckTypes.TypeExpr.t) ->
  'a DocOckTypes.TypeExpr.t * 'a DocOckTypes.TypeExpr.t

method type_decl : 'a DocOckTypes.TypeDecl.t -> 'a DocOckTypes.TypeDecl.t