Module `Component.Fmt`Source

Formatting functions for components

Sourcetype config = {

short_paths : bool;
show_canonical : bool;
show_removed : bool;
show_expansions : bool;
show_include_expansions : bool;

}

Sourceval default : config

Sourceval signature : config -> Format.formatter -> Signature.t -> unit

Sourceval removed_item : config -> Format.formatter -> Signature.removed_item -> unit

val removed_item_list : 
  config ->
  Format.formatter ->
  Signature.removed_item list ->
  unit

Sourceval class_ : config -> Format.formatter -> Class.t -> unit

Sourceval class_type : config -> Format.formatter -> ClassType.t -> unit

Sourceval include_ : config -> Format.formatter -> Include.t -> unit

Sourceval value : config -> Format.formatter -> Value.t -> unit

Sourceval module_decl : config -> Format.formatter -> Module.decl -> unit

Sourceval include_decl : config -> Format.formatter -> Include.decl -> unit

Sourceval module_ : config -> Format.formatter -> Module.t -> unit

Sourceval module_type : config -> Format.formatter -> ModuleType.t -> unit

Source

val simple_expansion : 
  config ->
  bool ->
  Format.formatter ->
  ModuleType.simple_expansion ->
  unit

Source

val module_type_type_of_desc : 
  config ->
  Format.formatter ->
  ModuleType.type_of_desc ->
  unit

Source

val u_module_type_expr : 
  config ->
  Format.formatter ->
  ModuleType.U.expr ->
  unit

Sourceval module_type_expr : config -> Format.formatter -> ModuleType.expr -> unit

Source

val functor_parameter : 
  config ->
  Format.formatter ->
  FunctorParameter.t ->
  unit

Source

val functor_parameter_parameter : 
  config ->
  Format.formatter ->
  FunctorParameter.parameter ->
  unit

Sourceval type_decl : config -> Format.formatter -> TypeDecl.t -> unit

Sourceval type_equation : config -> Format.formatter -> TypeDecl.Equation.t -> unit

Sourceval exception_ : config -> Format.formatter -> Exception.t -> unit

Sourceval extension : config -> Format.formatter -> Extension.t -> unit

Source

val substitution : 
  config ->
  Format.formatter ->
  ModuleType.substitution ->
  unit

Source

val substitution_list : 
  config ->
  Format.formatter ->
  ModuleType.substitution list ->
  unit

Sourceval type_expr_list : config -> Format.formatter -> TypeExpr.t list -> unit

Sourceval type_object : config -> Format.formatter -> TypeExpr.Object.t -> unit

Source

val type_class : 
  config ->
  Format.formatter ->
  (Cpath.class_type * TypeExpr.t list) ->
  unit

Sourceval type_package : config -> Format.formatter -> TypeExpr.Package.t -> unit

Source

val type_expr_polymorphic_variant : 
  config ->
  Format.formatter ->
  TypeExpr.Polymorphic_variant.t ->
  unit

Sourceval type_expr : config -> Format.formatter -> TypeExpr.t -> unit

Source

val resolved_module_path : 
  config ->
  Format.formatter ->
  Cpath.Resolved.module_ ->
  unit

Sourceval module_path : config -> Format.formatter -> Cpath.module_ -> unit

Source

val resolved_module_type_path : 
  config ->
  Format.formatter ->
  Cpath.Resolved.module_type ->
  unit

Sourceval module_type_path : config -> Format.formatter -> Cpath.module_type -> unit

Source

val resolved_type_path : 
  config ->
  Format.formatter ->
  Cpath.Resolved.type_ ->
  unit

Source

val resolved_value_path : 
  config ->
  Format.formatter ->
  Cpath.Resolved.value ->
  unit

Source

val resolved_parent_path : 
  config ->
  Format.formatter ->
  Cpath.Resolved.parent ->
  unit

Sourceval type_path : config -> Format.formatter -> Cpath.type_ -> unit

Sourceval value_path : config -> Format.formatter -> Cpath.value -> unit

Source

val resolved_class_type_path : 
  config ->
  Format.formatter ->
  Cpath.Resolved.class_type ->
  unit

Sourceval class_type_path : config -> Format.formatter -> Cpath.class_type -> unit

Sourceval model_path : config -> Format.formatter -> Odoc_model.Paths.Path.t -> unit

Source

val model_resolved_path : 
  config ->
  Format.formatter ->
  Odoc_model.Paths.Path.Resolved.t ->
  unit

Source

val model_identifier : 
  config ->
  Format.formatter ->
  Odoc_model.Paths.Identifier.t ->
  unit

Source

val model_fragment : 
  config ->
  Format.formatter ->
  Odoc_model.Paths.Fragment.t ->
  unit

Source

val model_resolved_fragment : 
  config ->
  Format.formatter ->
  Odoc_model.Paths.Fragment.Resolved.t ->
  unit

Sourceval resolved_root_fragment : config -> Format.formatter -> Cfrag.root -> unit

Source

val resolved_signature_fragment : 
  config ->
  Format.formatter ->
  Cfrag.resolved_signature ->
  unit

Source

val resolved_module_fragment : 
  config ->
  Format.formatter ->
  Cfrag.resolved_module ->
  unit

Source

val resolved_type_fragment : 
  config ->
  Format.formatter ->
  Cfrag.resolved_type ->
  unit

Sourceval signature_fragment : config -> Format.formatter -> Cfrag.signature -> unit

Sourceval module_fragment : config -> Format.formatter -> Cfrag.module_ -> unit

Source

val module_type_fragment : 
  config ->
  Format.formatter ->
  Cfrag.module_type ->
  unit

Sourceval type_fragment : config -> Format.formatter -> Cfrag.type_ -> unit

Source

val model_resolved_reference : 
  config ->
  Format.formatter ->
  Odoc_model.Paths.Reference.Resolved.t ->
  unit

Source

val model_reference : 
  config ->
  Format.formatter ->
  Odoc_model.Paths.Reference.t ->
  unit

Install

dune-project
Dependency

Authors

Maintainers

Sources

doc/odoc.xref2/Odoc_xref2/Component/Fmt/index.html

Module `Component.Fmt`Source

package odoc

Install

dune-project Dependency

Authors

Maintainers

Sources

doc/odoc.xref2/Odoc_xref2/Component/Fmt/index.html

Module Component.FmtSource

dune-project
Dependency

Module `Component.Fmt`Source