Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 83 lines (59 sloc) 2.005 kB
fccc685 Initial open-source release
MLstate authored
1 (*
2 Copyright © 2011 MLstate
3
4 This file is part of OPA.
5
6 OPA is free software: you can redistribute it and/or modify it under the
7 terms of the GNU Affero General Public License, version 3, as published by
8 the Free Software Foundation.
9
10 OPA is distributed in the hope that it will be useful, but WITHOUT ANY
11 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for
13 more details.
14
15 You should have received a copy of the GNU Affero General Public License
16 along with OPA. If not, see <http://www.gnu.org/licenses/>.
17 *)
18
19 (**
20 Guidelines for organizing modules in the framework.
21
22 @author Esther Baruk
23 *)
24
25 (**
26 This module explains the guidelines to follow for organizing your code.
27 It follows itself the guidelines !
28 *)
29
30 (** {6 Guidelines for interfaces} *)
31
32 (**
33 {ul {- If your comment takes several lines you must put a blank line before
34 and after it, this way :
35 {[(**
36 My comment
37 on several
38 lines
39 *)]}}
40 {- If you are the author of the module, you must write your name
41 in an author tag}
42 {- You must export only the functions that need to be.}}
43 *)
44
45
46
47 (** {6 Documentation about module} *)
48
49 (**
50 Please follow these guidelines :
51
52 {[(**
53 Module Foo, with a short explanation about Foo
54
55 \@author Jane Doe
56 *)]}
57
58 {[(**
59 Then comes a longer explanation about module Foo.
60 Please take time to provide examples and documentation.
61 *)]}
62 *)
63
64
65 (** {6 Error report} *)
66
67 (**
68 If your error must stay internal and should not be caught, don't
69 write anything in this section.
70 Else, you must export the informations about reporting errors
71 (i.e. type error, exception and printer, as said in the implementation)
72 *)
73
74 type error
75 exception Exception of error
76 val pp_error : error LangPrint.pprinter
77
78
79 (** {6 Signature of module} *)
80
81 (** Provide documentation about this function, how to use it, etc. *)
82 val function2 : unit -> unit
Something went wrong with that request. Please try again.