diff options
| author | Sébastien Hinderer <Sebastien.Hinderer@inria.fr> | 2022-06-16 17:09:53 +0200 |
|---|---|---|
| committer | Sébastien Hinderer <Sebastien.Hinderer@inria.fr> | 2022-06-30 18:30:19 +0200 |
| commit | 472c8108af002104680f0044123e5cc2c1f5e3bb (patch) | |
| tree | a87e8a6a0dbde8605914408bb7da90a3cf88a051 /ocamldoc/generators | |
| parent | 10416c56dfd04e9817481fc1a81fbae84723b8b2 (diff) | |
| download | ocaml-472c8108af002104680f0044123e5cc2c1f5e3bb.tar.gz | |
Provide an interface for ocamldoc's odoc_todo module
Diffstat (limited to 'ocamldoc/generators')
| -rw-r--r-- | ocamldoc/generators/odoc_todo.mli | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/ocamldoc/generators/odoc_todo.mli b/ocamldoc/generators/odoc_todo.mli new file mode 100644 index 0000000000..fce85d6600 --- /dev/null +++ b/ocamldoc/generators/odoc_todo.mli @@ -0,0 +1,32 @@ +(**************************************************************************) +(* *) +(* OCaml *) +(* *) +(* Sebastien Hinderer, projet Cambium, INRIA Paris *) +(* *) +(* Copyright 2022 Institut National de Recherche en Informatique et *) +(* en Automatique. *) +(* *) +(* All rights reserved. This file is distributed under the terms of *) +(* the GNU Lesser General Public License version 2.1, with the *) +(* special exception on linking described in the file LICENSE. *) +(* *) +(**************************************************************************) + +(** An OCamldoc generator to retrieve information in "todo" tags and + generate an html page with all todo items. *) + +module Naming = Odoc_html.Naming +module Html : Odoc_html.Html_generator + +module Generator : + sig + class scanner : + < html_of_text : ?with_p:bool -> Buffer.t -> Odoc_info.text -> unit; + .. > -> + object + inherit Odoc_scan.scanner + method buffer : Buffer.t + end + class html : Html.html + end |