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 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
|
module A = B
(** test *)
include A
(** @open *)
include B
(** @open *)
include A
type t = C of int (** docstring comment *)
type t = C of int [@ocaml.doc " docstring attribute "]
include Mod
(** comment *)
(** before *)
let x = 2
(** after *)
(**floatting1*)
(**floatting2*)
(**before*)
and y = 2
(** after *)
(** A *)
let a = 0
(** A' *)
module Comment_placement : sig
type t
(** Type *)
(** Variant declaration *)
type t = T
(** Type extension *)
type t += T
module A : B
(** Module *)
(** Module *)
module A : sig
type a
type b
end
val a : b
(** Val *)
exception E
(** Exception *)
include M
(** Include *)
(** Include *)
include sig
type a
type b
end
open M
(** Open *)
external a : b = "c"
(** External *)
module rec A : B
(** Rec module *)
(** Rec module *)
module rec A : sig
type a
type b
end
module type A
(** Module type *)
(** Module type *)
module type A = sig
type a
type b
end
class a : b
(** Class *)
class type a = b
(** Class type *)
(* [@@@some attribute] *)
(* (** Attribute *) *)
[%%some extension] (** Extension *)
(** A *)
external a : b = "double_comment"
(** B *)
(** This comment goes before *)
module S_ext : sig
type t
end
module Index : Index.S
(** This one goes after *)
module Index2
(Paramater_module : BAR_LONG_MODULE_TYPE_NAME)
(Foo : BAR)
(Foo : BAR)
(Foo : BAR)
(Foo : BAR)
(Foo : BAR) : sig end
(** This one _still_ goes after *)
module Make (Config : sig
val blah : string
(* this could be a really long signature *)
end) : S
(** Doc comment still goes after *)
module Gen () : S
(** Generative functor *)
end = struct
type t = {a: int}
(** Type *)
(** Variant declaration *)
type t = T
(** Type extension *)
type t += T
module A = B
(** Module *)
(** Module *)
module A = struct
type a = A
type b = B
end
(** Module *)
module A : sig
type a
type b
end =
B
(** Let *)
let a = b
exception E
(** Exception *)
include M
(** Include *)
(** Include *)
include struct
type a = A
type b = B
end
open M
(** Open *)
external a : b = "c"
(** External *)
module rec A : B = C
(** Rec module *)
(** Rec module *)
module rec A : B = struct
type a = A
type b = B
end
module type A = B
(** Module type *)
(** Module type *)
module type A = sig
type a
type b
end
class a = b
(** Class *)
(** Class *)
class b =
object
method f = 0
(** Method *)
inherit a
(** Inherit *)
val x = 1
(** Val *)
constraint 'a = [> ]
(** Constraint *)
initializer do_init ()
(** Initialiser *)
end
class type a = b
(** Class type *)
(* [@@@some attribute] *)
(* (** Attribute *) *)
(** Extension *)[%%some
extension]
(* ;; *)
(* (** Eval *) *)
(* 1 + 1 *)
(* ;; *)
(** A *)
external a : b = "double_comment"
(** B *)
end
(** A *)
exception A of int
(** C *)
(** {1:lbl Heading} *)
(** {2 heading without label} *)
module A = struct
module B = struct
(** It does not try to saturate
(1a) A = B + C /\ B = D + E => A = C + D + E
Nor combine more than 2 equations
(1b) A = B + C /\ B = D + E /\ F = C + D + E => A = F
xxxxxxxxxxxxxxxxxxxxxxxxxxxx
(2) A = B + C /\ B = D + E => A = C + D - E
*)
let a b = ()
end
end
(* Same with get_pure, except that when we have both "x = t" and "y = t" where t is a primed ident,
* we add "x = y" to the result. This is crucial for the normalizer, as it tend to drop "x = t" before
* processing "y = t". If we don't explicitly preserve "x = y", the normalizer cannot pick it up *)
let _ = ()
(** Tags without text *)
(** @see <Abc> *)
(** @before a *)
(** @deprecated *)
(** @param b *)
(** @raise c *)
(** @return *)
(** @see 'file' *)
(** @see "title" *)
(**
starts with linebreaks
*)
let a = 1
(** {@metadata[ Code block with metadata field ]} *)
(** {@some_tag[ Code block with metadata field. This is a big block that should hopefully break ]} *)
(** {@ocaml[
let _ =
f
@@
{ aaa= aaa bbb ccc
; bbb= aaa bbb ccc
; ccc= aaa bbb ccc }
>>= fun () ->
let _ = x in
f @@ g @@ h @@ fun x -> y
]} *)
(**{v
foo
v}*)
[@@@a] ;;
a ;;
(** cmt *)
b ;;
c ;;
d ;;
[%%e ""] ;;
(** doc *)
a ;;
b
|