doc: fix odoc markups

Author: EmileRolley

src/app/learnocaml_common.mli

@@ -121,7 +121,7 @@ val get_state_as_save_file : ?include_reports:bool -> unit -> Save.t
 (** Sync the local save state with the server state, and returns the merged save
     file. The save will be created on the server if it doesn't exist.
 
-    This syncs student {b,content}, but never the reports which are only synched
+    This syncs student {b content}, but never the reports which are only synched
     on "Grade" *)
 val sync: Token.t -> Save.t Lwt.t
 

src/app/learnocaml_config.mli

@@ -5,10 +5,12 @@
  * Learn-OCaml is distributed under the terms of the MIT license. See the
  * included LICENSE file for details.  *)
 
-(* This is not transpiled to learnocaml-static.js, but is an interface
+(** This is not transpiled to learnocaml-static.js, but is an interface
    to the values stored in this file.  It is "statically linked" with
    learnocaml-common.ml. *)
 
+module Js = Js_of_ocaml.Js
+
 class type learnocaml_config = object
   method enableTryocaml: bool Js.optdef_prop
   method enableLessons: bool Js.optdef_prop

src/grader/test_lib.mli

@@ -267,7 +267,7 @@ module type S = sig
     val test : 'a tester
 
     (** [test_ignore] is a {!S.tester} that compares only the constructor of its
-       {S.result} inputs. The content is ignored. If the constructors
+       {!S.result} inputs. The content is ignored. If the constructors
        match, an empty report is returned. *)
     val test_ignore : 'a tester
 
@@ -284,7 +284,7 @@ module type S = sig
     val test_eq_exn : (exn -> exn -> bool) -> 'a tester
 
     (** [test_canon canon] builds a {!S.tester} that compares its two
-       {S.result} inputs after application to [canon] function with
+       {!S.result} inputs after application to [canon] function with
        Ocaml structural equality. *)
     val test_canon : ('a result -> 'a result) -> 'a tester
 
@@ -379,7 +379,7 @@ module type S = sig
        also made at this time and so mutate during solution
        execution. They can then be compared with [out.test].
 
-       [out.test] is a {S.tester} which actually builds two reports,
+       [out.test] is a {!S.tester} which actually builds two reports,
        one using its optional argument [~test_result] and one that
        compares the values of the references set previously using
        [test_ref]. By default [~test_result] is equal to
@@ -581,7 +581,7 @@ module type S = sig
 
     (** {3 Returned report}*)
 
-    (** The grading functions for functions return a {report} which
+    (** The grading functions for functions return a {!report} which
        actually concatenated 4 reports generated by (in this order):
 
       - the tester [~test]
@@ -1000,37 +1000,42 @@ module type S = sig
     (** The various grading functions use numerous common optional
        argument. Here is a list in alphabetic order of each of them.
 
-    {3 ?⁠after} defines a function which is called with the current
+    {3 ?⁠after}
+    defines a function which is called with the current
        tested inputs, the student {!type:result} and the solution
        {!type:result} and returns a new report which is concatenated to
        reports built with [~test], [~test_sdtout] and [~test_sdterr].
        Enables for example to inspect references introduced with
        [~before], [~before_user] or [~before_reference] and build an
        appropriate report. Default value is [fun _ _ _ -> []].
 
-    {3 ?before} defines a function called right before the application
+    {3 ?before}
+    defines a function called right before the application
        of student function to the current tested inputs. Default value
        is [fun _ -> ()]
 
      For [test_function_<args_nb>] only.
 
-    {3 ?before_reference} defines a function called right before the
+    {3 ?before_reference}
+    defines a function called right before the
        application of solution function to the current tested
        inputs. This function is called {b before} student function
        evaluation. Default value is [fun _ -> ()].
 
      For [test_function_<args_nb>_against] and
        [test_function_<args_nb>_against_solution].
 
-    {3 ?before_user} defines a function called right before the
+    {3 ?before_user}
+    defines a function called right before the
        application of student function to the current tested
        inputs. This function is called {b after} solution function
        evaluation. Default value is [fun _ -> ()].
 
      For [test_function_<args_nb>_against] and
        [test_function_<args_nb>_against_solution].
 
-    {3 ?gen} Number of automatically generated tested inputs. Inputs
+    {3 ?gen}
+    Number of automatically generated tested inputs. Inputs
        are generated using either sampler defined in the current
        environment or function defined with [~sampler] optional
        argument. By default, [gen] is [max 5 (10 - List.length
@@ -1041,7 +1046,8 @@ module type S = sig
 
      See {{!Sampler.sampler_sec}Sampler module}.
 
-    {3 ?sampler} defines the function used to automatically generated
+    {3 ?sampler}
+    defines the function used to automatically generated
        inputs. If unset, the grading function checks if a sampler is
        defined for each input type in the current environment. Such
        sampler for a type [some-type] must be named [sample_some-type]
@@ -1053,20 +1059,23 @@ module type S = sig
 
      See {{!Sampler.sampler_sec}Sampler module}.
 
-    {3 ?test} defines the function used to compare the output of
+    {3 ?test}
+    defines the function used to compare the output of
        student function and the output of solution function. Default
        value is {!Tester.test}.
 
      See {{!Tester.tester_sec}predefined testers and tester builders}.
 
-    {3 ?test_sdterr} defines the function used to compare the standard
+    {3 ?test_sdterr}
+    defines the function used to compare the standard
        output produced by student function and the one produced by
        solution function. Default value is {!Tester.io_test_ignore}.
 
      See {{!Tester.io_tester_sec}predefined IO testers and IO tester
        builders}.
 
-    {3 ?test_sdtout} defines the function used to compare the standard
+    {3 ?test_sdtout}
+    defines the function used to compare the standard
        error produced by student function and the one produced by
        solution function. Default value is {!Tester.io_test_ignore}.
 
@@ -1085,7 +1094,7 @@ module type S = sig
 
     (** [run_timeout ?time v] executes [v()] under an optional time limit.
         The exceptions raised by [v] are intentionally *not* caught,
-        so the caller is able to catch and get a backtrace, if desired. 
+        so the caller is able to catch and get a backtrace, if desired.
         If given, [time] overrides the global timeout parameter.
     *)
     val run_timeout : ?time:int -> (unit -> 'a) -> 'a

src/state/learnocaml_data.mli

@@ -210,9 +210,8 @@ module Exercise: sig
       Token.Set.t -> assignments -> (status * Token.Set.t) list
 
     (** Computes the current set of skills from the base list (from Meta.t),
-        using the mutable changes in the Status.skill list. E.g. {[
-          get_skills ~base:meta.Meta.requirements st.skills_prereq
-        ]} *)
+        using the mutable changes in the Status.skill list. E.g.
+        {[get_skills ~base:meta.Meta.requirements st.skills_prereq]} *)
     val get_skills: base:string list -> skill list -> string list
 
     (** The opposite of [get_skills]: retrieves the base from the already
@@ -226,7 +225,8 @@ module Exercise: sig
     val skills_focus: Meta.t -> t -> string list
 
     (** Generates a skill list that can be saved, such that
-        {[get_skills ~base (make_skills ~base l) = l]}.
+        {[get_skills ~base (make_skills ~base l) = l]}
+        .
 
         Remember to call [skills_base] first on the base if you got the
         skills from the meta returned by the server. *)

src/toplevel/learnocaml_toplevel.mli

@@ -53,7 +53,7 @@ type t
      the previous outputs are kept and marked as old
      (see {!Learnocaml_toplevel_output.oldify}). Otherwise, the output console is cleaned.
    @param input_sizing
-     See (!Learnocaml_toplevel_input.sizing}.
+     See {!Learnocaml_toplevel_input.sizing}.
    @param history
      The history storage to use. If none, a new volatile one is created.
    @param display_welcome
@@ -98,7 +98,7 @@ val make_flood_popup:
 
     @param timeout
       See {!create}.
-    @returns
+    @return
       Returns [Success true] whenever the code was correctly
       typechecked and its evaluation did not raise an exception nor
       timeouted and [false] otherwise. *)
@@ -114,7 +114,7 @@ val execute_phrase: t ->
       Tells if answers of the toplevel are to be displayed.
     @param message
       Displays [(* message *)] where the code should have been echoed.
-    @returns
+    @return
        Returns [Success true] whenever the code was correctly
        typechecked and its evaluation did not raise an exception nor
        timeouted and [false] otherwise. *)
@@ -152,7 +152,7 @@ val prerr_string: t -> string -> unit
 val print_html: t -> string -> unit
 
 (** scroll the view to show the last phrase.
-    Calls {!Learnocaml_toplevel_output.scroll. *)
+    Calls {!Learnocaml_toplevel_output.scroll}. *)
 val scroll: t -> unit
 
 (** Execute the content of the input [textarea].

src/toplevel/learnocaml_toplevel_worker_caller.mli

@@ -8,10 +8,12 @@
 
 (** An unified interface for OCaml toplevels running in a Web Worker
     or not. This module signature is very simalar to the signature of
-    {!module:Learnocaml_toplevel_toploop}, except: {ul {- all blocking functions
-    will kill the underlying Web Worker when cancelled; a new worker
-    will be spawned. } {- it uses function of type [string -> unit] as
-    outputs instead of [Format.formatter].}}. *)
+    {!module:Learnocaml_toplevel_toploop}, except:
+      {ul
+      {- all blocking functions will kill the underlying Web Worker when
+        cancelled; a new worker will be spawned. }
+      {- it uses function of type [string -> unit] as outputs instead
+        of [Format.formatter].}} *)
 
 open Toploop_results