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 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
|
.TH Toplevel_comments 3 "" "Odoc" "OCaml Library"
.SH Name
Toplevel_comments
.SH Synopsis
.sp
.in 2
\fBModule Toplevel_comments\fR
.in
.sp
.fi
A doc comment at the beginning of a module is considered to be that module's doc\.
.nf
.SH Documentation
.sp
.nf
\f[CB]module\fR \f[CB]type\fR T = \f[CB]sig\fR
.br
.ti +2
\f[CB]type\fR t
.br
\f[CB]end\fR
.fi
.br
.ti +2
Doc of T, part 1\.
.nf
.sp
\f[CB]module\fR Include_inline : \f[CB]sig\fR \.\.\. \f[CB]end\fR
.fi
.br
.ti +2
Doc of T, part 2\.
.nf
.sp
\f[CB]module\fR Include_inline' : \f[CB]sig\fR \.\.\. \f[CB]end\fR
.fi
.br
.ti +2
Doc of Include_inline, part 1\.
.nf
.sp
\f[CB]module\fR \f[CB]type\fR Include_inline_T = \f[CB]sig\fR
.br
.ti +2
\f[CB]type\fR t
.br
\f[CB]end\fR
.fi
.br
.ti +2
Doc of T, part 2\.
.nf
.sp
\f[CB]module\fR \f[CB]type\fR Include_inline_T' = \f[CB]sig\fR
.br
.ti +2
\f[CB]type\fR t
.br
\f[CB]end\fR
.fi
.br
.ti +2
Doc of Include_inline_T', part 1\.
.nf
.sp
\f[CB]module\fR M : \f[CB]sig\fR \.\.\. \f[CB]end\fR
.fi
.br
.ti +2
Doc of M
.nf
.sp
\f[CB]module\fR M' : \f[CB]sig\fR \.\.\. \f[CB]end\fR
.fi
.br
.ti +2
Doc of M' from outside
.nf
.sp
\f[CB]module\fR M'' : \f[CB]sig\fR \.\.\. \f[CB]end\fR
.fi
.br
.ti +2
Doc of M'', part 1\.
.nf
.sp
\f[CB]module\fR Alias : T
.fi
.br
.ti +2
Doc of Alias\.
.nf
.sp
\f[CB]class\fR c1 : int \f[CB]\->\fR \f[CB]object\fR \.\.\. \f[CB]end\fR
.fi
.br
.ti +2
Doc of c1, part 1\.
.nf
.sp
\f[CB]class\fR \f[CB]type\fR ct = \f[CB]object\fR \f[CB]end\fR
.fi
.br
.ti +2
Doc of ct, part 1\.
.nf
.sp
\f[CB]class\fR c2 : ct
.fi
.br
.ti +2
Doc of c2\.
.nf
.sp
\f[CB]module\fR Ref_in_synopsis : \f[CB]sig\fR \.\.\. \f[CB]end\fR
.fi
.br
.ti +2
\f[CI]t\fR\.
.nf
.sp
\f[CB]module\fR Comments_on_open : \f[CB]sig\fR \.\.\. \f[CB]end\fR
|