Update docs

Author: linev

modules/base/ObjectPainter.mjs

@@ -182,8 +182,8 @@ class ObjectPainter extends BasePainter {
      * @param {object} obj - new version of object, values will be updated in original object
      * @param {string} [opt] - when specified, new draw options
      * @returns {boolean|Promise} for object redraw
-     * @desc Two actions typically done by redraw - update object content via {@link ObjectPainter.updateObject} and
-      * then redraw correspondent pad via {@link ObjectPainter.redrawPad}. If possible one should redefine
+     * @desc Two actions typically done by redraw - update object content via {@link ObjectPainter#updateObject} and
+      * then redraw correspondent pad via {@link ObjectPainter#redrawPad}. If possible one should redefine
       * only updateObject function and keep this function unchanged. But for some special painters this function is the
       * only way to control how object can be update while requested from the server
       * @protected */
@@ -269,7 +269,7 @@ class ObjectPainter extends BasePainter {
    }
 
    /** @summary Checks if draw elements were resized and drawing should be updated.
-     * @desc Redirects to {@link TPadPainter.checkCanvasResize}
+     * @desc Redirects to {@link TPadPainter#checkCanvasResize}
      * @private */
    checkResize(arg) {
       let p = this.getCanvPainter();
@@ -291,7 +291,7 @@ class ObjectPainter extends BasePainter {
    }
 
    /** @summary Returns created <g> element used for object drawing
-     * @desc Element should be created by {@link ObjectPainter.createG}
+     * @desc Element should be created by {@link ObjectPainter#createG}
      * @protected */
    getG() { return this.draw_g; }
 
@@ -484,7 +484,7 @@ class ObjectPainter extends BasePainter {
    }
 
    /** @summary Converts pad SVG x or y coordinates into axis values.
-     * @desc Reverse transformation for {@link ObjectPainter.axisToSvg}
+     * @desc Reverse transformation for {@link ObjectPainter#axisToSvg}
      * @param {string} axis - name like "x" or "y"
      * @param {number} coord - graphics coordiante.
      * @param {boolean} ndc - kind of return value

modules/core.mjs

@@ -83,13 +83,11 @@ function isArrayProto(proto) {
     return proto.length == 14 ? 1 : 2;
 }
 
-/** @summary Specialized JSROOT constants, used in {@link settings}
-  * @namespace
-  * @private */
+/** @desc Specialized JSROOT constants, used in {@link settings}
+  * @namespace */
 let constants = {
    /** @summary Kind of 3D rendering, used for {@link settings.Render3D}
-     * @namespace
-     * @private */
+     * @namespace */
    Render3D: {
       /** @summary Default 3D rendering, normally WebGL, if not supported - SVG */
       Default: 0,
@@ -107,29 +105,27 @@ let constants = {
       }
    },
    /** @summary Way to embed 3D into SVG, used for {@link settings.Embed3D}
-     * @namespace
-     * @private */
+     * @namespace */
    Embed3D: {
       /** @summary Do not embed 3D drawing, use complete space */
       NoEmbed: -1,
-      /** @summary Default embeding mode, on Firefox is really ```Embed```, on all other ```Overlay``` */
+      /** @summary Default embeding mode - on Firefox and latest Chrome is real ```Embed```, on all other ```Overlay``` */
       Default: 0,
-      /** @summary WebGL canvas not inserted into SVG, but just overlayed The only way how Chrome browser can be used */
+      /** @summary WebGL canvas not inserted into SVG, but just overlayed The only way how earlier Chrome browser can be used */
       Overlay: 1,
-      /** @summary Really embed WebGL Canvas into SVG, only works with Firefox */
+      /** @summary Really embed WebGL Canvas into SVG */
       Embed: 2,
-      /** @summary Embeding, but when SVG rendering or SVG image converion is used
-        * @private */
+      /** @summary Embeding, but when SVG rendering or SVG image converion is used */
       EmbedSVG: 3,
+      /** @summary Convert string values into number  */
       fromString: function(s) {
          if (s === "embed") return this.Embed;
          if (s === "overlay") return this.Overlay;
          return this.Default;
       }
    },
    /** @summary How to use latex in text drawing, used for {@link settings.Latex}
-     * @namespace
-     * @private */
+     * @namespace */
    Latex: {
       /** @summary do not use Latex at all for text drawing */
       Off: 0,
@@ -141,6 +137,7 @@ let constants = {
       MathJax: 3,
       /** @summary always use MathJax for text rendering */
       AlwaysMathJax: 4,
+      /** @summary Convert string values into number */
       fromString: function(s) {
          if (!s || (typeof s !== 'string'))
             return this.Normal;
@@ -164,12 +161,12 @@ let constants = {
    }
 };
 
-/** @summary Central JSROOT settings, independent from {@link gStyle}
+/** @desc Global JSROOT settings
   * @namespace */
 let settings = {
    /** @summary Render of 3D drawing methods, see {@link constants.Render3D} for possible values */
    Render3D: constants.Render3D.Default,
-   /** @summary Render of 3D drawing methods in batch mode, see {@link constants.Render3D} for possible values */
+   /** @summary 3D drawing methods in batch mode, see {@link constants.Render3D} for possible values */
    Render3DBatch: constants.Render3D.Default,
    /** @summary Way to embed 3D drawing in SVG, see {@link constants.Embed3D} for possible values */
    Embed3D: constants.Embed3D.Default,

modules/gui.mjs

@@ -102,6 +102,9 @@ function readStyleFromURL(url) {
 
 
 /** @summary Build main GUI
+  * @desc Used in many HTML files to create JSROOT GUI elements
+  * @param {String} gui_element - id of the `<div>` element
+  * @param {String} [gui_kind] - either "online", "nobrowser", "draw"
   * @returns {Promise} when completed  */
 function buildGUI(gui_element, gui_kind) {
    let myDiv = (typeof gui_element == 'string') ? d3_select('#' + gui_element) : d3_select(gui_element);

modules/gui/display.mjs

@@ -127,7 +127,7 @@ class MDIDisplay extends BasePainter {
 /**
  * @summary Custom MDI display
  *
- * @desc All HTML frames should be created before and add via {@link CustomDisplay.addFrame} calls
+ * @desc All HTML frames should be created before and add via {@link CustomDisplay#addFrame} calls
  * @private
  */
 

modules/io.mjs

@@ -2680,12 +2680,11 @@ class TDirectory {
       });
    }
 
-} // TDirectory
+} // class TDirectory
 
 /**
   * @summary Interface to read objects from ROOT files
   *
-  * @hideconstructor
   * @desc Use {@link openFile} to create instance of the class
   */
 
@@ -2739,7 +2738,7 @@ class TFile {
    }
 
    /** @summary Assign BufferArray with file contentOpen file
-    * @private */
+     * @private */
    assignFileContent(bufArray) {
       this.fFileContent = new TBuffer(new DataView(bufArray));
       this.fAcceptRanges = false;
@@ -2748,8 +2747,8 @@ class TFile {
    }
 
    /** @summary Open file
-    * @returns {Promise} after file keys are read
-    * @private */
+     * @returns {Promise} after file keys are read
+     * @private */
    _open() {
       if (!this.fAcceptRanges || this.fSkipHeadRequest)
          return this.readKeys();
@@ -3300,7 +3299,7 @@ class TFile {
 
    /** @summary Read the directory content from  a root file
      * @desc If directory was already read - return previously read object
-     * Same functionality as {@link TFile.readObject}
+     * Same functionality as {@link TFile#readObject}
      * @param {string} dir_name - directory name
      * @param {number} [cycle] - directory cycle
      * @returns {Promise} - promise with read directory */