Skip to content
Snippets Groups Projects
Commit 93bdc8a8 authored by Loïc Correnson's avatar Loïc Correnson
Browse files

[ivette] generate documentation for API

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