summaryrefslogtreecommitdiff
path: root/stdlib/spacetime.mli
diff options
context:
space:
mode:
authoroctachron <octa@polychoron.fr>2017-01-21 18:27:34 +0100
committeroctachron <octa@polychoron.fr>2017-02-01 20:20:02 +0100
commitc4d49c89c1e769c0b9b2cfd7b6b131262fafef3e (patch)
tree712d2a8a87565be3f7c854ab249c8a360af9357f /stdlib/spacetime.mli
parent9369c3515ebbfa4b44cb85ae60c933cc93330efe (diff)
downloadocaml-c4d49c89c1e769c0b9b2cfd7b6b131262fafef3e.tar.gz
Add cross-reference detected by ocamldoc
Diffstat (limited to 'stdlib/spacetime.mli')
-rw-r--r--stdlib/spacetime.mli8
1 files changed, 4 insertions, 4 deletions
diff --git a/stdlib/spacetime.mli b/stdlib/spacetime.mli
index 5f3b51e64d..1105275e06 100644
--- a/stdlib/spacetime.mli
+++ b/stdlib/spacetime.mli
@@ -62,7 +62,7 @@ module Series : sig
(** [save_event] writes an event, which is an arbitrary string, into the
given series file. This may be used for identifying particular points
during program execution when analysing the profile.
- The optional [time] parameter is as for [Snapshot.take].
+ The optional [time] parameter is as for {!Snapshot.take}.
*)
val save_event : ?time:float -> t -> event_name:string -> unit
@@ -70,7 +70,7 @@ module Series : sig
interpeting the snapshots that [series] contains and then closes the
[series] file. This function must be called to produce a valid series
file.
- The optional [time] parameter is as for [Snapshot.take].
+ The optional [time] parameter is as for {!Snapshot.take}.
*)
val save_and_close : ?time:float -> t -> unit
end
@@ -81,7 +81,7 @@ module Snapshot : sig
result to the [series] file. This function triggers a minor GC but does
not allocate any memory itself.
If the optional [time] is specified, it will be used instead of the
- result of [Sys.time] as the timestamp of the snapshot. Such [time]s
+ result of {!Sys.time} as the timestamp of the snapshot. Such [time]s
should start from zero and be monotonically increasing. This parameter
is intended to be used so that snapshots can be correlated against wall
clock time (which is not supported in the standard library) rather than
@@ -90,6 +90,6 @@ module Snapshot : sig
val take : ?time:float -> Series.t -> unit
end
-(** Like [Series.save_event], but writes to the automatic snapshot file.
+(** Like {!Series.save_event}, but writes to the automatic snapshot file.
This function is a no-op if OCAML_SPACETIME_INTERVAL was not set. *)
val save_event_for_automatic_snapshots : event_name:string -> unit