Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

[doc] review: Review of stlib.core.funaction

  • Loading branch information...
commit ca2e70bf832d03adf6269ebab0a6c1745de9e7b6 1 parent d55bfe2
Guillem Rieu authored
Showing with 27 additions and 2 deletions.
  1. +27 −2 stdlib/core/funaction/funaction.opa
View
29 stdlib/core/funaction/funaction.opa
@@ -20,6 +20,7 @@ import stdlib.core.{web.core, rpc.core, js}
/**
* Make some magic things with fun action.
+ *
* @category compiler
* @destination private
* @author Quentin Bourgerie
@@ -28,10 +29,22 @@ import stdlib.core.{web.core, rpc.core, js}
*/
/**
+ * {1 Client-side}
+ */
+
+/**
+ * {2 Types defined in this module}
+ */
+
+/**
* Type of a fun action
*/
type FunAction.t = Dom.event -> void
+/**
+ * {2 Interface}
+ */
+
@opacapi @client
callFA(json : string, event : Dom.event): void =
t = @typeval(FunAction.t)
@@ -65,7 +78,7 @@ FunAction = {{
}}
/**
- This module contains the runtime to serialize js call site in html using the adhoc S2 mode,
+ This module contains the runtime to serialize js call site in html using the ad hoc S2 mode,
Entry point used by the compiler are alias defined above:
FunActionServer_serialize_call and FunActionServer_serialize_argument
@@ -141,12 +154,24 @@ FunAction = {{
*/
+/**
+ * {1 Server-side}
+ */
+
+/**
+ * {2 Types defined in this module}
+ */
+
type FunActionServer.serialized_arg('a) = {arg : 'a ; serialized_arg : string}
+/**
+ * {2 Interface}
+ */
+
FunActionServer = {{
/** serialize an argument to a FunActionServer.serialized_arg
- the serialised_arg field is suitable as js code source
+ the serialized_arg field is suitable as js code source
*/
serialize_argument(__toplevel_var,arg)=
#<Ifstatic:OPA_OPTIMIZE_RPC_I 1>
Please sign in to comment.
Something went wrong with that request. Please try again.