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
|
(*
* ocamlweb - A WEB-like tool for ocaml
* Copyright (C) 1999-2001 Jean-Christophe FILLITRE and Claude MARCH
*
* This software is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License version 2, as published by the Free Software Foundation.
*
* This software 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 PURPOSE.
*
* See the GNU Library General Public License version 2 for more details
* (enclosed in the file LGPL).
*)
(*i $Id: doclexer.mli,v 1.5 2001/06/15 11:46:21 filliatr Exp $ i*)
(*s Caml files are represented by the record [caml_file], which
contains their file names and their module names. The functions
[module_name] and [make_caml_file] are used to construct such
values. *)
type caml_file = { caml_filename : string; caml_module : string }
val module_name : string -> string
val make_caml_file : string -> caml_file
type file_type =
| File_impl of caml_file
| File_intf of caml_file
| File_lex of caml_file
| File_yacc of caml_file
| File_other of string
(*s The following function [read_one_file] reads a Caml file,
separating the sections, and separating the paragraphs inside the
sections. The boolean reference [skip_header] indicates whether the
header must be skipped. [web_style] records if web sections were
used anywhere in any file. *)
val skip_header : bool ref
val web_style : bool ref
val read_one_file : file_type -> Web.file
|
