Skip to content

Commit 38e4753

Browse files
committed
next docs update
1 parent 79dd04d commit 38e4753

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

modules/gui.mjs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,12 @@ function readStyleFromURL(url) {
104104
/** @summary Build main GUI
105105
* @desc Used in many HTML files to create JSROOT GUI elements
106106
* @param {String} gui_element - id of the `<div>` element
107-
* @param {String} [gui_kind] - either "online", "nobrowser", "draw"
108-
* @returns {Promise} when completed */
109-
function buildGUI(gui_element, gui_kind) {
107+
* @param {String} gui_kind - either "online", "nobrowser", "draw"
108+
* @returns {Promise} with {@link HierarchyPainter} instance
109+
* @example
110+
* import { buildGUI } from '/path_to_jsroot/modules/gui.mjs';
111+
* buildGUI("guiDiv"); */
112+
function buildGUI(gui_element, gui_kind = "") {
110113
let myDiv = (typeof gui_element == 'string') ? d3_select('#' + gui_element) : d3_select(gui_element);
111114
if (myDiv.empty())
112115
return Promise.reject(Error('no div for gui found'));

modules/tree.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2519,7 +2519,7 @@ function treeProcess(tree, selector, args) {
25192519

25202520
}
25212521

2522-
/** @summary implementation of TTree::Draw
2522+
/** @summary implementation of TTree::Draw
25232523
* @param {object|string} args - different setting or simply draw expression
25242524
* @param {string} args.expr - draw expression
25252525
* @param {string} [args.cut=undefined] - cut expression (also can be part of 'expr' after '::')

modules/webwindow.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -635,7 +635,7 @@ class WebWindowHandle {
635635
* @param {object} arg.receiver - instance of receiver for websocket events, allows to initiate connection immediately
636636
* @param {string} [arg.first_recv] - required prefix in the first message from RWebWindow, remain part of message will be returned in handle.first_msg
637637
* @param {string} [arg.href] - URL to RWebWindow, using window.location.href by default
638-
* @returns {Promise} ready-to-use WebWindowHandle instance */
638+
* @returns {Promise} ready-to-use {@link WebWindowHandle} instance */
639639
function connectWebWindow(arg) {
640640

641641
if (typeof arg == 'function')

0 commit comments

Comments
 (0)