[server] module header documentation

src/plugins/server/data.mli

@@ -21,7 +21,10 @@
 (**************************************************************************)
 
 (* -------------------------------------------------------------------------- *)
-(** {2 Data Encoding}
+(** Data Encoding. *)
+
+(* -------------------------------------------------------------------------- *)
+(** {2 Datatypes}
 
     This module is responsible for marshaling and demarshaling data
     to handle communications between the server and the client in both

src/plugins/server/doc.ml

@@ -31,6 +31,10 @@ module Pages = Map.Make(String)
 
 type chapter = [ `Protocol | `Kernel | `Plugin of string ]
 
+(* Section contents can be generated statically or dynamically.
+   Typically, general kernel dictionary entries can be extended by plugins.
+   The general case is to have a function that builds the (final) content
+   on demand. *)
 type section = (unit -> Markdown.elements)
 
 type page = {

src/plugins/server/jbuffer.mli

@@ -20,6 +20,8 @@
 (*                                                                        *)
 (**************************************************************************)
 
+(** Rich text buffers with JSON marshalling. *)
+
 type json = Json.t
 
 (** All-in-one formatter. Return the JSON encoding of formatted text. *)

src/plugins/server/kernel_ast.mli

@@ -20,12 +20,12 @@
 (*                                                                        *)
 (**************************************************************************)
 
-open Cil_types
-
 (* -------------------------------------------------------------------------- *)
 (** Ast Data *)
 (* -------------------------------------------------------------------------- *)
 
+open Cil_types
+
 module Kf : Data.S_collection with type t = kernel_function
 module Ki : Data.S_collection with type t = kinstr
 module Stmt : Data.S_collection with type t = stmt

src/plugins/server/kernel_properties.mli

@@ -20,6 +20,8 @@
 (*                                                                        *)
 (**************************************************************************)
 
+(** Kernel Property Status *)
+
 (** Documentation of ACSL extensions for [propkind] server data. *)
 val register_propkind :
   name:string ->

src/plugins/server/states.mli

@@ -20,6 +20,8 @@
 (*                                                                        *)
 (**************************************************************************)
 
+(** Synchronized values between Server & Client *)
+
 type 'a callback = ('a -> unit) -> unit
 
 (** Register a (projectified) value and generates the associated signal and