Markup.Foo
The first special comment of the file is the comment associated with the whole module.
Special comments can be placed between elements and are kept by the OCamldoc tool, but are not associated to any element. @
-tags in these comments are ignored.
Comments like the one above, with more than two asterisks, are ignored.
Comment for exception My_exception, even with a simple comment between the special comment and the exception.
type weather =
| Rain of int | (* The comment for constructor Rain *) |
| Sun | (* The comment for constructor Sun *) |
Comment for type weather
type weather2 =
| Rain of int | (* The comment for constructor Rain *) |
| Sun | (* The comment for constructor Sun *) |
Comment for type weather2
I can continue the comment for type weather2 here because there is already a comment associated to the last constructor.
The comment for type my_record
Continuation of comment for type my_record
class cl : object ... end
Interesting information about cl
class my_class : object ... end
The comment for class my_class
class type my_class_type = object ... end
The comment for the class type my_class_type
module Foo : sig ... end
The comment for module Foo
module type my_module_type = sig ... end
The comment for module type my_module_type.