Skip to content

Commit 79dd04d

Browse files
committed
Add central file for documentaion
1 parent f234f0e commit 79dd04d

File tree

4 files changed

+40
-7
lines changed

4 files changed

+40
-7
lines changed

docs/main.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# JavaScript ROOT
2+
3+
JavaScript ROOT provides interactive ROOT-like graphics in the web browsers.
4+
Data can be read and displayed from binary and JSON ROOT files.
5+
JSROOT implements user interface for THttpServer class.
6+
7+
<a href="https://root.cern/js/latest/?nobrowser&file=../files/hsimple.root&item=ntuple;1&opt=px:py::pz%3E4"><img src="https://root.cern/js/files/img/ttree.png" align="left" hspace="10" vspace="6" alt="TTree::Draw()" title="2-dimensional TTree::Draw with cut options"></a>
8+
<a href="https://root.cern/js/latest/?nobrowser&file=../files/histpainter6.root&item=draw_hstack;1"><img src="https://root.cern/js/files/img/thstack.png" align="left" hspace="10" vspace="6" alt="THStack" title="Several varians of THStack drawing"></a>
9+
<a href="https://root.cern/js/latest/?nobrowser&json=../files/geom/simple_alice.json.gz&file=../files/geom/tracks_hits.root&item=simple_alice.json.gz+tracks_hits.root/tracks;1+tracks_hits.root/hits;1"><img src="https://root.cern/js/files/img/geo_tracks.png" align="left" hspace="10" vspace="6" alt="Geometry" title="Drawing of TGeo model superimposed with tracks and hits"></a>
10+
<br/>
11+
<br/>
12+
<br/>
13+
<br/>
14+
<br/>
15+
<br/>
16+
<br/>
17+
18+
19+
## Links
20+
21+
Project web pages:
22+
23+
[https://root.cern/js/](https://root.cern/js/)
24+
25+
[https://jsroot.gsi.de](https://jsroot.gsi.de/)
26+
27+
28+
## Examples
29+
30+
[JSROOT examples](https://root.cern/js/latest/examples.htm)
31+
32+
[JSROOT API examples](https://root.cern/js/latest/api.htm)
33+

modules/base/ObjectPainter.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1609,7 +1609,7 @@ function resize(dom, arg) {
16091609

16101610
/** @summary Safely remove all drawings from specified element
16111611
* @param {string|object} dom - id or DOM element
1612-
* @requires painter
1612+
* @public
16131613
* @example
16141614
* cleanup("drawing");
16151615
* cleanup(document.querySelector("#drawing")); */

modules/draw.mjs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ function setDefaultDrawOpt(classname, opt) {
286286
* @param {object} obj - object to draw, object type should be registered before with {@link addDrawFunc}
287287
* @param {string} opt - draw options separated by space, comma or semicolon
288288
* @returns {Promise} with painter object
289-
* @requires painter
289+
* @public
290290
* @desc An extensive list of support draw options can be found on [examples page]{@link https://root.cern/js/latest/examples.htm}
291291
* @example
292292
* let file = await openFile("https://root.cern/js/files/hsimple.root");
@@ -405,9 +405,9 @@ function draw(dom, obj, opt) {
405405
* @param {object} obj - object to draw, object type should be registered before with {@link addDrawFunc}
406406
* @param {string} opt - draw options
407407
* @returns {Promise} with painter object
408-
* @requires painter
409408
* @desc If drawing was not done before, it will be performed with {@link draw}.
410-
* Otherwise drawing content will be updated */
409+
* Otherwise drawing content will be updated
410+
* @public */
411411
function redraw(dom, obj, opt) {
412412

413413
if (!obj || (typeof obj !== 'object'))

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "jsroot",
3-
"version": "6.99.99",
3+
"version": "7.0.0",
44
"engines": {
55
"node": ">=0.14.8"
66
},
@@ -65,7 +65,7 @@
6565
},
6666
"scripts": {
6767
"build": "rollup -c build/rollup.config.js",
68-
"doc": "jsdoc -a public -a undefined -c docs/jsdoc.json",
69-
"full": "jsdoc -c docs/jsdoc.json -p -d docs/jsdocfull"
68+
"doc": "jsdoc -c docs/jsdoc.json -R docs/main.md",
69+
"full": "jsdoc -c docs/jsdoc.json -p -d docs/jsdocfull -R docs/main.md"
7070
}
7171
}

0 commit comments

Comments
 (0)