package frama-c

  1. Overview
  2. Docs
package frama-c
Legend:
Library
Module
Module type
Parameter
Class
Class type

Server Documentation

type chapter = [
  1. | `Protocol
  2. | `Kernel
  3. | `Plugin of string
]

The main chapters of the documentation.

type page

A page of the server documentation.

val path : page -> string
val href : page -> string -> Frama_c_kernel.Markdown.href
val chapter : page -> chapter
val page : chapter -> title:string -> ?descr:Frama_c_kernel.Markdown.elements -> ?readme:Frama_c_kernel.Filepath.Normalized.t -> filename:string -> unit -> page

Obtain the given page in the server documentation.

The readme introductory section is read from the share directory:

  • frama-c/share/<filename> server and kernel pages,
  • frama-c/share/<plugin>/server/<filename> for plugin's pages.
val publish : page:page -> ?name:string -> ?index:string list -> title:string -> ?contents:Frama_c_kernel.Markdown.elements -> ?generated:(unit -> Frama_c_kernel.Markdown.elements) -> unit -> Frama_c_kernel.Markdown.href

Adds a section in the corresponding page. Returns an href to the published section. If index items are provided, they are added to the server documentation index.

val protocol : title:string -> readme:string -> unit

Publish a protocol.

val package : Package.packageInfo -> unit

Publish a package.

val dump : root:Frama_c_kernel.Filepath.Normalized.t -> ?meta:bool -> unit -> unit

Dumps all published pages of documentations. Unless ~meta:false, also generates METADATA for each page in <filename>.json for each page.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct