From 137c3a10b43830bf8bb026c37ea0cc56e734921a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Loi=CC=88c=20Correnson?= <loic.correnson@cea.fr>
Date: Wed, 5 Jan 2022 16:26:38 +0100
Subject: [PATCH] [ivette/doc] fix documentation
---
ivette/Makefile | 5 +++--
ivette/src/dome/renderer/table/arrays.ts | 4 ++--
ivette/src/dome/renderer/text/buffers.ts | 2 +-
ivette/tsconfig.json | 1 -
4 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/ivette/Makefile b/ivette/Makefile
index 4f3a0f25ee7..c2b5abe73d4 100644
--- a/ivette/Makefile
+++ b/ivette/Makefile
@@ -119,7 +119,8 @@ DOC_GUIDES= src/dome/doc/guides
NODEBIN= ./node_modules/.bin
-DOCDIRS= src/ivette src/frama-c src/dome/renderer src/dome/utils
+DOCDIRS= src/ivette src/dome/renderer src/dome/utils src/frama-c/api
+DOCFILES= src/frama-c/server.ts src/frama-c/states.ts $(shell find $(DOCDIRS) -name "*.ts" -or -name "*.tsx")
icons: $(DOC_ICONS_GALLERY)
@@ -131,7 +132,7 @@ $(DOC_ICONS_GALLERY): $(DOC_ICONS_MAKE) $(DOC_ICONS_DATA)
doc: $(NODEBIN)/typedoc icons
@echo "\n[Ivette] documentation"
@rm -fr doc/html
- @yarn run typedoc $(shell find $(DOCDIRS) -name "*.ts" -or -name "*.tsx")
+ @yarn run typedoc $(DOCFILES)
@echo "\n[Ivette] main page"
@echo " file://$(PWD)/doc/html/index.html"
diff --git a/ivette/src/dome/renderer/table/arrays.ts b/ivette/src/dome/renderer/table/arrays.ts
index 95e459ab91b..5dc126e4f90 100644
--- a/ivette/src/dome/renderer/table/arrays.ts
+++ b/ivette/src/dome/renderer/table/arrays.ts
@@ -43,13 +43,13 @@ import {
export type ByColumns<Row> = { [dataKey: string]: Compare.Order<Row> };
-interface PACK<Key, Row> {
+export interface PACK<Key, Row> {
index: number | undefined;
key: Key;
row: Row;
}
-type SORT<K, R> = Order<PACK<K, R>>;
+export type SORT<K, R> = Order<PACK<K, R>>;
function orderBy<K, R>(
columns: ByColumns<R>,
diff --git a/ivette/src/dome/renderer/text/buffers.ts b/ivette/src/dome/renderer/text/buffers.ts
index 5fe857bd0dd..50a6ad13107 100644
--- a/ivette/src/dome/renderer/text/buffers.ts
+++ b/ivette/src/dome/renderer/text/buffers.ts
@@ -113,7 +113,7 @@ function byVisibleTag(lmin: number, lmax: number) {
// --- Buffer
// --------------------------------------------------------------------------
-type TextMarker = CodeMirror.TextMarker<CodeMirror.MarkerRange>;
+export type TextMarker = CodeMirror.TextMarker<CodeMirror.MarkerRange>;
export interface RichTextBufferProps {
diff --git a/ivette/tsconfig.json b/ivette/tsconfig.json
index e276642778a..5674a51edb4 100644
--- a/ivette/tsconfig.json
+++ b/ivette/tsconfig.json
@@ -97,7 +97,6 @@
"excludeExternals": true,
"categorizeByGroup": false,
"categoryOrder": [ "Hooks", "Components", "*", "Other" ],
- "listInvalidSymbolLinks":true,
"hideGenerator":true,
"includes": "src/dome/doc/guides",
"customCss": "src/dome/doc/gallery.css",
--
GitLab