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
|
.TH Stop 3 "" "Odoc" "OCaml Library"
.SH Name
Stop
.SH Synopsis
.sp
.in 2
\fBModule Stop\fR
.in
.sp
.fi
This test cases exercises stop comments\.
.nf
.SH Documentation
.sp
.nf
\f[CB]val\fR foo : int
.fi
.br
.ti +2
This is normal commented text\.
.nf
.sp
.fi
The next value is bar, and it should be missing from the documentation\. There is also an entire module, M, which should also be hidden\. It contains a nested stop comment, but that stop comment should not turn documentation back on in this outer module, because stop comments respect scope\.
.nf
.sp
.fi
Documentation is on again\.
.sp
Now, we have a nested module, and it has a stop comment between its two items\. We want to see that the first item is displayed, but the second is missing, and the stop comment disables documenation only in that module, and not in this outer module\.
.nf
.sp
\f[CB]module\fR N : \f[CB]sig\fR \.\.\. \f[CB]end\fR
.sp
\f[CB]val\fR lol : int
|