Marking methods as private which should be private

Author: linev

modules/base/BasePainter.mjs

@@ -64,7 +64,8 @@ function getAbsPosInCanvas(sel, pos) {
   * @param {number} value - value to convert
   * @param {string} [fmt="6.4g"] - format can be like 5.4g or 4.2e or 6.4f
   * @param {boolean} [ret_fmt] - when true returns array with value and actual format like ["0.1","6.4f"]
-  * @returns {string|Array} - converted value or array with value and actual format */
+  * @returns {string|Array} - converted value or array with value and actual format
+  * @private */
 function floatToString(value, fmt, ret_fmt) {
    if (!fmt) fmt = "6.4g";
 

modules/base/colors.mjs

@@ -5,7 +5,8 @@ function toHex(num,scale) {
    return s.length == 1 ? '0'+s : s;
 }
 
-/** @summary list of global root colors */
+/** @summary list of global root colors
+  * @private */
 let gbl_colors_list = [];
 
 /** @summary Generates all root colors, used also in jstests to reset colors
@@ -106,7 +107,8 @@ function adoptRootColors(objarr) {
 
 /** @summary Return ROOT color by index
   * @desc Color numbering corresponds typical ROOT colors
-  * @returns {String} with RGB color code or existing color name like 'cyan' */
+  * @returns {String} with RGB color code or existing color name like 'cyan'
+  * @private */
 function getColor(indx) {
    return gbl_colors_list[indx];
 }

modules/core.mjs

@@ -353,7 +353,8 @@ function getDocument() {
 
 /** @summary Inject javascript code
   * @desc Replacement for eval
-  * @returns {Promise} */
+  * @returns {Promise}
+  * @private */
 function injectCode(code) {
    if (nodejs) {
       let name, fs;
@@ -785,7 +786,8 @@ function decodeUrl(url) {
    return res;
 }
 
-/** @summary Find function with given name */
+/** @summary Find function with given name
+  * @private */
 function findFunction(name) {
    if (typeof name === 'function') return name;
    if (typeof name !== 'string') return null;
@@ -922,9 +924,10 @@ function httpRequest(url, kind, post_data) {
 }
 
 /** @summary Create some ROOT classes
-  * @desc Supported classes: "TObject", "TNamed", "TList", "TAxis", "TLine", "TText", "TLatex", "TPad", "TCanvas"
+  * @desc Supported classes: `TObject`, `TNamed`, `TList`, `TAxis`, `TLine`, `TText`, `TLatex`, `TPad`, `TCanvas`
   * @param {string} typename - ROOT class name
   * @example
+  * import { create } from 'path_to_jsroot/modules/core.mjs';
   * let obj = create("TNamed");
   * obj.fName = "name";
   * obj.fTitle = "title"; */

modules/geom/csg.mjs

@@ -769,7 +769,8 @@ class Geometry {
 
 } // class Geometry
 
-   /** @summary create geometry to make cut on specified axis */
+/** @summary create geometry to make cut on specified axis
+  * @private */
 function createNormal(axis_name, pos, size) {
    if (!size || (size < 10000)) size = 10000;
 

modules/gpad/TCanvasPainter.mjs

@@ -18,7 +18,8 @@ import { TPadPainter } from './TPadPainter.mjs';
 
 
 /** @summary direct draw of TFrame object,
-  * @desc pad or canvas should already exist */
+  * @desc pad or canvas should already exist
+  * @private */
 function directDrawTFrame(dom, obj, opt) {
    let fp = new TFramePainter(dom, obj);
    fp.addToPadPrimitives();
@@ -741,7 +742,8 @@ function drawTPadSnapshot(dom, snap /*, opt*/) {
    });
 }
 
-/** @summary draw TGaxis object */
+/** @summary draw TGaxis object
+  * @private */
 function drawTGaxis(dom, obj, opt) {
    let painter = new TAxisPainter(dom, obj, false);
    painter.disable_zooming = true;
@@ -751,7 +753,8 @@ function drawTGaxis(dom, obj, opt) {
    }).then(() => painter);
 }
 
-/** @summary draw TGaxis object */
+/** @summary draw TGaxis object
+  * @private */
 function drawTFrame(dom, obj, opt) {
    let fp = new TFramePainter(dom, obj);
    return ensureTCanvas(fp, false).then(() => {

modules/gui/utils.mjs

@@ -342,7 +342,8 @@ function addMoveHandler(painter, enabled) {
 }
 
 /** @summary Inject style
-  * @param {String} code - css string */
+  * @param {String} code - css string
+  * @private */
 function injectStyle(code, node) {
    if (isBatchMode() || !code || (typeof document === 'undefined'))
       return true;

modules/io.mjs

@@ -48,7 +48,8 @@ const clTObject = 'TObject', clTNamed = 'TNamed', clTObjString = 'TObjString', c
 /** @summary Custom streamers for root classes
   * @desc map of user-streamer function like func(buf,obj)
   * or alias (classname) which can be used to read that function
-  * or list of read functions */
+  * or list of read functions
+  * @private */
 const CustomStreamers = {
    TObject(buf, obj) {
       obj.fUniqueID = buf.ntou4();
@@ -482,8 +483,9 @@ function addUserStreamer(type, user_streamer) {
 }
 
 
- /** @summary these are streamers which do not handle version regularly
-  * @desc used for special classes like TRef or TBasket */
+/** @summary these are streamers which do not handle version regularly
+  * @desc used for special classes like TRef or TBasket
+  * @private */
 const DirectStreamers = {
    // do nothing for these classes
    TQObject() {},
@@ -3072,9 +3074,9 @@ class TFile {
      * @param {number} [cycle] - cycle number, also can be included in obj_name
      * @returns {Promise} promise with object read
      * @example
-     *   let f = await openFile("https://root.cern/js/files/hsimple.root");
-     *   let obj = await f.readObject("hpxpy;1");
-     *   console.log(`Read object of type ${obj._typename}`); */
+     * let f = await openFile("https://root.cern/js/files/hsimple.root");
+     * let obj = await f.readObject("hpxpy;1");
+     * console.log(`Read object of type ${obj._typename}`); */
    readObject(obj_name, cycle, only_dir) {
 
       let pos = obj_name.lastIndexOf(";");
@@ -3738,6 +3740,8 @@ class TNodejsFile extends TFile {
   * @param {string|object} arg - argument for file open like url, see details
   * @returns {object} - Promise with {@link TFile} instance when file is opened
   * @example
+  *
+  * import { openFile } from '/path_to_jsroot/modules/io.mjs';
   * let f = await openFile("https://root.cern/js/files/hsimple.root");
   * console.log(`Open file ${f.getFileName()}`); */
 function openFile(arg) {

modules/tree.mjs

@@ -286,7 +286,8 @@ function getBranchObjectClass(branch, tree, with_clones = false, with_leafs = fa
 
 /** @summary Get branch with specified id
   * @desc All sub-branches checked as well
-  * @returns {Object} branch */
+  * @returns {Object} branch
+  * @private */
 function getTreeBranch(tree, id) {
    if (!Number.isInteger(id)) return;
    let res, seq = 0;
@@ -368,7 +369,8 @@ function findBranchComplex(tree, name, lst = undefined, only_search = false) {
 
 /** @summary Search branch with specified name
   * @param {string} name - name of the branch
-  * @returns {Object} found branch */
+  * @returns {Object} found branch
+  * @private */
 function findBranch(tree, name) {
    let res = findBranchComplex(tree, name, tree.fBranches, true);
    return (!res || (res.rest.length > 0)) ? null : res.branch;
@@ -377,7 +379,8 @@ function findBranch(tree, name) {
 
 /** @summary Returns number of branches in the TTree
   * @desc Checks also sub-branches in the branches
-  * @returns {number} number of branches */
+  * @returns {number} number of branches
+  * @private */
 function getNumBranches(tree) {
    function count(obj) {
       if (!obj || !obj.fBranches) return 0;