File: section.mli

package info (click to toggle)
ocaml-odoc 3.1.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 14,012 kB
  • sloc: ml: 60,567; javascript: 2,572; sh: 560; makefile: 31
file content (30 lines) | stat: -rw-r--r-- 641 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
(* Blank lines are needed because of
   https://caml.inria.fr/mantis/view.php?id=7701. *)

(** This is the module comment. Eventually, sections won't be allowed in it. *)

(** {1 Empty section} *)

(** {1 Text only}

    Foo bar. *)

(** {1 Aside only} *)

(** Foo bar. *)

(** {1 Value only} *)

val foo : unit

(** {1 Empty section}

    {1 within a comment}

    {2 and one with a nested section} *)

(** {1 {e This} [section] {b title} {_has} {^markup}}

    But links are impossible thanks to the parser, so we never have trouble
    rendering a section title in a table of contents - no link will be nested
    inside another link. *)