Commit 93bdc8a8 authored by Loïc Correnson's avatar Loïc Correnson
Browse files

[ivette] generate documentation for API

parent 912b76b1
......@@ -3,7 +3,7 @@
/**
Dive Services
@packageDocumentation
@module frama-c/dive
@module api/dive
*/
//@ts-ignore
......
......@@ -3,7 +3,7 @@
/**
Ast Services
@packageDocumentation
@module frama-c/kernel/ast
@module api/kernel/ast
*/
//@ts-ignore
......
......@@ -3,7 +3,7 @@
/**
Informations
@packageDocumentation
@module frama-c/kernel/data
@module api/kernel/data
*/
//@ts-ignore
......@@ -34,19 +34,19 @@ export type text = null | string | text[];
/** Loose decoder for `text` */
export const jText: Json.Loose<text> =
(_x) => Json.jUnion<null | string | text[]>(
Json.jNull,
Json.jString,
Json.jList(jText),
)(_x);
(_x: any) => Json.jUnion<null | string | text[]>(
Json.jNull,
Json.jString,
Json.jList(jText),
)(_x);
/** Safe decoder for `text` */
export const jTextSafe: Json.Safe<text> =
(_x) => Json.jFail(jText,'Text expected')(_x);
(_x: any) => Json.jFail(jText,'Text expected')(_x);
/** Natural order for `text` */
export const byText: Compare.Order<text> =
(_x,_y) => Compare.structural(_x,_y);
(_x: any, _y: any) => Compare.structural(_x,_y);
/** Enum Tag Description */
export type tag = { name: string, label: markdown, descr: markdown };
......
......@@ -3,7 +3,7 @@
/**
Project Management
@packageDocumentation
@module frama-c/kernel/project
@module api/kernel/project
*/
//@ts-ignore
......
......@@ -3,7 +3,7 @@
/**
Property Services
@packageDocumentation
@module frama-c/kernel/properties
@module api/kernel/properties
*/
//@ts-ignore
......
......@@ -3,7 +3,7 @@
/**
Kernel Services
@packageDocumentation
@module frama-c/kernel/services
@module api/kernel/services
*/
//@ts-ignore
......
......@@ -258,12 +258,12 @@ let makeOrder ~self ~names fmt js =
let makeRecursive fn fmt js =
if Pkg.isRecursive js then
Format.fprintf fmt "(_x) => %a(_x)" fn js
Format.fprintf fmt "(_x: any) => %a(_x)" fn js
else fn fmt js
let makeRecursive2 fn fmt js =
if Pkg.isRecursive js then
Format.fprintf fmt "(_x,_y) => %a(_x,_y)" fn js
Format.fprintf fmt "(_x: any, _y: any) => %a(_x,_y)" fn js
else fn fmt js
let makeDeclaration fmt names d =
......@@ -440,7 +440,7 @@ let makePackage pkg name fmt =
if pkg.p_descr <> [] then
Format.fprintf fmt "@\n @[<hov 0>%a@]@\n@\n" pp_descr pkg.p_descr ;
Format.fprintf fmt " @@packageDocumentation@\n" ;
Format.fprintf fmt " @@module frama-c/%s@\n" name ;
Format.fprintf fmt " @@module api/%s@\n" name ;
Format.fprintf fmt "*/@\n@." ;
let names = Pkg.resolve ~keywords pkg in
makeIgnore fmt "import * as Json from 'dome/data/json';@\n" ;
......
......@@ -98,8 +98,8 @@
"readme": "./README.md",
"inputFiles": [
"doc/pages",
"src/frama-c",
"src/dome/src/renderer"
"src/frama-c", "api",
"src/dome/src/renderer",
]
}
}
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment