package odoc

  1. Overview
  2. Docs
package odoc
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

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