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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
(**************************************************************************)
(* *)
(* This file is part of Calendar. *)
(* *)
(* Copyright (C) 2003-2011 Julien Signoles *)
(* *)
(* you can redistribute it and/or modify it under the terms of the GNU *)
(* Lesser General Public License version 2.1 as published by the *)
(* Free Software Foundation, with a special linking exception (usual *)
(* for Objective Caml libraries). *)
(* *)
(* It is distributed in the hope that it will be useful, *)
(* but WITHOUT ANY WARRANTY; without even the implied warranty of *)
(* MERCHANTABILITY or FITNESS FOR A PARTICULAR *)
(* *)
(* See the GNU Lesser General Public Licence version 2.1 for more *)
(* details (enclosed in the file LGPL). *)
(* *)
(* The special linking exception is detailled in the enclosed file *)
(* LICENSE. *)
(**************************************************************************)
(* $Id: example.ml.3 249 2012-06-27 08:11:14Z signoles $ *)
(** Add a tag @example *)
class example = object (self)
inherit Odoc_html.html as super
method html_of_example txt =
let buf = Buffer.create 97 in
self#html_of_text buf txt;
Format.sprintf "%s<br>\n" (Buffer.contents buf);
method html_of_examples = function
| [] -> ""
| [ txt ] -> Format.sprintf "<b>Example:</b> %s" (self#html_of_example txt)
| examples ->
let s = Format.sprintf "<b>Examples:</b><ul>" in
let s =
List.fold_left
(fun acc txt ->
Format.sprintf "%s<li>%s</li>"
acc
(self#html_of_example txt))
s
examples;
in
Format.sprintf "%s</ul>" s
(** Redefine [html_of_custom] *)
method html_of_custom b l =
let examples = ref [] in
List.iter
(fun (tag, text) ->
try
if tag = "example" then examples := text :: !examples
else assert false
with
Not_found ->
Odoc_info.warning (Odoc_messages.tag_not_handled tag))
l;
Buffer.add_string b (self#html_of_examples !examples)
initializer
tag_functions <- ("example", self#html_of_example) :: tag_functions
end
let () =
Odoc_args.set_doc_generator (Some ((new example) :> Odoc_args.doc_generator))
|
