package odoc

  1. Overview
  2. Docs
OCaml Documentation Generator

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (24)

Authors

  1. Anton Bachin
  2. Daniel Bünzli
  3. D
    David Sheets <sheets@alum.mit.edu>
  4. J
    Jon Ludlam <jon@recoil.org>
  5. J
    Jules Aguillon <juloo.dsi@gmail.com>
  6. L
    Leo White <leo@lpw25.net>
  7. L
    Lubega Simon <lubegasimon73@gmail.com>
  8. P
    Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>
  9. T
    Thomas Refis <trefis@janestreet.com>

Maintainers

  1. Daniel Bünzli
  2. J
    Jon Ludlam <jon@recoil.org>
  3. J
    Jules Aguillon <juloo.dsi@gmail.com>
  4. P
    Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>

Sources

odoc-3.0.0.tbz
sha256=ce84fa7e0cc5f3e8a54e6adeb10826152798b602057b9e46c5ae7e5d5206812b
sha512=9febd413450ca2e3824c9ef7e1c9ae8d8094aa72ed71327a69d8d6b42f6f197b3f3f40d674de0d11fa1242ee0df95c693b5d74467d530704e1339f3a523452f6

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

Module Component.FmtSource

Formatting functions for components

Sourcetype config = {
  1. short_paths : bool;
  2. show_canonical : bool;
  3. show_removed : bool;
  4. show_expansions : bool;
  5. 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
Sourceval 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
Sourceval simple_expansion : config -> bool -> Format.formatter -> ModuleType.simple_expansion -> unit
Sourceval module_type_type_of_desc : config -> Format.formatter -> ModuleType.type_of_desc -> unit
Sourceval u_module_type_expr : config -> Format.formatter -> ModuleType.U.expr -> unit
Sourceval module_type_expr : config -> Format.formatter -> ModuleType.expr -> unit
Sourceval functor_parameter : config -> Format.formatter -> FunctorParameter.t -> unit
Sourceval 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
Sourceval substitution : config -> Format.formatter -> ModuleType.substitution -> unit
Sourceval 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
Sourceval type_class : config -> Format.formatter -> (Cpath.class_type * TypeExpr.t list) -> unit
Sourceval type_package : config -> Format.formatter -> TypeExpr.Package.t -> unit
Sourceval type_expr_polymorphic_variant : config -> Format.formatter -> TypeExpr.Polymorphic_variant.t -> unit
Sourceval type_expr : config -> Format.formatter -> TypeExpr.t -> unit
Sourceval resolved_module_path : config -> Format.formatter -> Cpath.Resolved.module_ -> unit
Sourceval module_path : config -> Format.formatter -> Cpath.module_ -> unit
Sourceval resolved_module_type_path : config -> Format.formatter -> Cpath.Resolved.module_type -> unit
Sourceval module_type_path : config -> Format.formatter -> Cpath.module_type -> unit
Sourceval resolved_type_path : config -> Format.formatter -> Cpath.Resolved.type_ -> unit
Sourceval resolved_value_path : config -> Format.formatter -> Cpath.Resolved.value -> unit
Sourceval 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
Sourceval 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_resolved_path : config -> Format.formatter -> Odoc_model.Paths.Path.Resolved.t -> unit
Sourceval model_identifier : config -> Format.formatter -> Odoc_model.Paths.Identifier.t -> unit
Sourceval model_fragment : config -> Format.formatter -> Odoc_model.Paths.Fragment.t -> unit
Sourceval model_resolved_fragment : config -> Format.formatter -> Odoc_model.Paths.Fragment.Resolved.t -> unit
Sourceval resolved_root_fragment : config -> Format.formatter -> Cfrag.root -> unit
Sourceval resolved_signature_fragment : config -> Format.formatter -> Cfrag.resolved_signature -> unit
Sourceval resolved_module_fragment : config -> Format.formatter -> Cfrag.resolved_module -> unit
Sourceval 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
Sourceval module_type_fragment : config -> Format.formatter -> Cfrag.module_type -> unit
Sourceval type_fragment : config -> Format.formatter -> Cfrag.type_ -> unit
Sourceval model_resolved_reference : config -> Format.formatter -> Odoc_model.Paths.Reference.Resolved.t -> unit
Sourceval model_reference : config -> Format.formatter -> Odoc_model.Paths.Reference.t -> unit
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct