From ef9bc0047e168d88e688744aac721f813e4fc3e9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Loi=CC=88c=20Correnson?= <loic.correnson@cea.fr>
Date: Wed, 6 May 2020 17:16:48 +0200
Subject: [PATCH] [ivette] configuring typedoc options
---
ivette/src/dome/src/renderer/dnd.js | 2 +-
ivette/src/dome/src/renderer/dome.js | 6 +++---
ivette/src/dome/src/renderer/frame/sidebars.js | 1 -
ivette/src/dome/src/renderer/frame/tabs.js | 2 +-
ivette/src/dome/src/renderer/frame/toolbars.js | 2 --
ivette/src/dome/src/renderer/text/editors.js | 5 ++---
ivette/tsconfig.json | 11 +++++++++--
7 files changed, 16 insertions(+), 13 deletions(-)
diff --git a/ivette/src/dome/src/renderer/dnd.js b/ivette/src/dome/src/renderer/dnd.js
index b27c0ef3e5c..603de8c4280 100644
--- a/ivette/src/dome/src/renderer/dnd.js
+++ b/ivette/src/dome/src/renderer/dnd.js
@@ -200,7 +200,7 @@ export const dispatchEvent = ( dragging , handlers ) => {
The handler object shall define listeners to the D&D dragging events.
Each callback is sensible to specific kind of events, as specified
- in the [[dome/dnd | event listeners]] documentation.
+ in the [[dome/dnd]] documentation.
You need a D&D controller whenever an element can be dragged
between different containers. D&D controllers also offers an
diff --git a/ivette/src/dome/src/renderer/dome.js b/ivette/src/dome/src/renderer/dome.js
index 3547d86f4f4..a50223b1aaf 100644
--- a/ivette/src/dome/src/renderer/dome.js
+++ b/ivette/src/dome/src/renderer/dome.js
@@ -133,8 +133,8 @@ emitted by the `Main` process when the application instance is launched.
See also:
- [[useCommand]]
- - [[System.getArguments]]
- - [[System.getWorkingDir]]
+ - `System.getArguments`
+ - `System.getWorkingDir`
*/
export function onCommand(job) { emitter.on('dome.command',job); }
@@ -665,7 +665,7 @@ const NULL = {}; // Dummy initial value
Returns the command-line arguments and working directory for the application
instance running in the window. Automatically updated on `dome.command` events.
- See also [Dome.onCommand](#.onCommand) event handler.
+ See also [[onCommand]] event handler.
*/
export function useCommand() {
useUpdate('dome.command');
diff --git a/ivette/src/dome/src/renderer/frame/sidebars.js b/ivette/src/dome/src/renderer/frame/sidebars.js
index c4b6ce3b177..e8c5da03242 100644
--- a/ivette/src/dome/src/renderer/frame/sidebars.js
+++ b/ivette/src/dome/src/renderer/frame/sidebars.js
@@ -28,7 +28,6 @@ const SideBarContext = React.createContext();
@property {function} [onSelection] - Selection callback
@property {function} [onContextMenu] - Context Menu callback
@description
- See also [[Frame]] containers.
When a base settings is set on the sidebar, all contained
sections and items are attributed derived settings based on their identifiers.
diff --git a/ivette/src/dome/src/renderer/frame/tabs.js b/ivette/src/dome/src/renderer/frame/tabs.js
index 3a8fff85f0d..fe89a5691e8 100644
--- a/ivette/src/dome/src/renderer/frame/tabs.js
+++ b/ivette/src/dome/src/renderer/frame/tabs.js
@@ -51,7 +51,7 @@ const HIDDEN = { display: 'none' };
@property {boolean} [content] - render content instead of tab
@description
A single tab selector. Shall only be used as a children
- of [[TabsBar]] or [[Frame]].
+ of [[TabsBar]].
When `content` is positionned, the component renders
its content children instead of the tab button. In such a case, content
diff --git a/ivette/src/dome/src/renderer/frame/toolbars.js b/ivette/src/dome/src/renderer/frame/toolbars.js
index c17ea7ca1ff..a34a6c5f091 100644
--- a/ivette/src/dome/src/renderer/frame/toolbars.js
+++ b/ivette/src/dome/src/renderer/frame/toolbars.js
@@ -18,8 +18,6 @@ import './style.css' ;
/**
@class
@summary Container for toolbar items.
- @description
- See also [[Frame]] containers.
*/
export class ToolBar extends React.Component {
diff --git a/ivette/src/dome/src/renderer/text/editors.js b/ivette/src/dome/src/renderer/text/editors.js
index 6eb0c8f28cc..6040d63c4eb 100644
--- a/ivette/src/dome/src/renderer/text/editors.js
+++ b/ivette/src/dome/src/renderer/text/editors.js
@@ -25,8 +25,7 @@ const CSS_SELECTED = 'dome-xText-select' ;
/**
@class
@summary Rich Text Editor.
- @property {Buffer} buffer -
- associated [[Buffer]] holding the text content
+ @property {Buffer} buffer - associated Buffer holding the text content
@property {string} className - additional class name(s)
@property {object} style - additional CSS style
@property {number} fontSize - editor font-size
@@ -38,7 +37,7 @@ const CSS_SELECTED = 'dome-xText-select' ;
@description
A component rendering the content of a text buffer, that shall be instances
- of the [[Buffer]] base class.
+ of the `Buffer` base class.
The view is based on a [CodeMirror](https://codemirror.net) component linked with
the internal Code Mirror Document from the associated buffer.
diff --git a/ivette/tsconfig.json b/ivette/tsconfig.json
index c153f4aa0d8..21834d78d30 100644
--- a/ivette/tsconfig.json
+++ b/ivette/tsconfig.json
@@ -80,14 +80,21 @@
],
"typedocOptions": {
"name": "Ivette Documentation",
- "includeVersion": true,
- "disableSources": true,
"mode": "modules",
"out": "doc/html",
+ "includeVersion": true,
+ "disableSources": true,
"excludePrivate": true,
+ "excludeNotExported": true,
+ "excludeExternals": true,
+ "categorizeByGroup": false,
+ "categoryOrder": [ "Hooks", "Components", "*", "Other" ],
"stripInternal": true,
+ "listInvalidSymbolLinks":true,
+ "hideGenerator":true,
"readme": "./README.md",
"inputFiles": [
+ "doc/pages",
"src/frama-c",
"src/dome/src/renderer"
]
--
GitLab