Merge pull request #406 from iLib-js/docUpdate

Update JS API doc more

Author: gouniLee

js/lib/Address.js

@@ -1,7 +1,7 @@
 /*
  * Address.js - Represent a mailing address
  *
- * Copyright © 2013-2015, 2018, JEDLSoft
+ * Copyright © 2013-2015, 2018, 2023 JEDLSoft
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -466,7 +466,7 @@ Address.prototype = {
 
     /**
      * Find the named country either at the end or the beginning of the address.
-     * @protected
+     * @private
      */
     _findCountry: function(name) {
         var start = -1, match, line = 0;

js/lib/AsyncNodeLoader.js

@@ -1,5 +1,5 @@
 /*
- * AsyncAsyncNodeLoader.js - Loader implementation for nodejs with asynchronous calls.
+ * AsyncNodeLoader.js - Loader implementation for nodejs with asynchronous calls.
  * Mostly this is used for testing the async calls
  *
  * Copyright © 2018, 2020 JEDLSoft

js/lib/CType.js

@@ -1,7 +1,7 @@
 /*
  * CType.js - Character type definitions
  *
- * Copyright © 2012-2015, 2018, JEDLSoft
+ * Copyright © 2012-2015, 2018, 2023 JEDLSoft
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -72,7 +72,7 @@ var CType = {};
  * <li>Pf - Final_Punctuation
  * </ul>
  *
- * @protected
+ * @private
  * @param {number} num code point of the character to examine
  * @param {string} rangeName the name of the range to check
  * @param {Object} obj object containing the character range data
@@ -294,7 +294,7 @@ CType.withinRange = function(ch, rangeName) {
 };
 
 /**
- * @protected
+ * @private
  * @param {boolean} sync
  * @param {Object|undefined} loadParams
  * @param {function(*)|undefined} onLoad
@@ -304,7 +304,7 @@ CType._init = function(sync, loadParams, onLoad) {
 };
 
 /**
- * @protected
+ * @private
  * @param {string} name
  * @param {boolean} sync
  * @param {Object|undefined} loadParams

js/lib/Calendar.js

@@ -1,7 +1,7 @@
 /*
  * Calendar.js - Represent a calendar object.
  *
- * Copyright © 2012-2015, JEDLSoft
+ * Copyright © 2012-2015, 2023 JEDLSoft
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,11 +20,12 @@
 /**
  * @class
  * Superclass for all calendar subclasses that contains shared
- * functionality. This class is never instantiated on its own. Instead,
+ * functionality.  
+ * This class is never instantiated on its own. Instead,
  * you should use the {@link CalendarFactory} function to manufacture a new
  * instance of a subclass of Calendar.
  *
- * @private
+ * @protected
  * @constructor
  */
 var Calendar = function() {

js/lib/CharmapTable.js

@@ -1,7 +1,7 @@
 /*
  * CharmapTable.js - A character set mapping class that maps using trie table
  *
- * Copyright © 2014-2015, 2018, JEDLSoft
+ * Copyright © 2014-2015, 2018, 2023 JEDLSoft
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -116,7 +116,7 @@ var IString = require("./IString.js");
  * missing data synchronously.
  *
  * @constructor
- * @see {ilib.setLoaderCallback} for information about registering a loader callback instance
+ * @see {@link ilib#setLoaderCallback} for information about registering a loader callback instance
  * @extends Charmap
  * @param {Object=} options options which govern the construction of this instance
  */

js/lib/Charset.js

@@ -1,7 +1,7 @@
 /*
  * Charset.js - Return information about a particular character set
  *
- * Copyright © 2014-2015, 2018, JEDLSoft
+ * Copyright © 2014-2015, 2018, 2023 JEDLSoft
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -64,7 +64,7 @@ var Utils = require("./Utils.js");
  * missing data synchronously.
  *
  * @constructor
- * @see {ilib.setLoaderCallback} for information about registering a loader callback instance
+ * @see {@link ilib#setLoaderCallback} for information about registering a loader callback instance
  * @param {Object=} options options which govern the construction of this instance
  */
 var Charset = function(options) {

js/lib/CopticCal.js

@@ -1,7 +1,7 @@
 /*
  * CopticCal.js - Represent a Coptic calendar object.
  *
- * Copyright © 2015,2018, JEDLSoft
+ * Copyright © 2015,2018, 2023 JEDLSoft
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,7 +17,6 @@
  * limitations under the License.
  */
 
-var Utils = require("./Utils.js");
 var Calendar = require("./Calendar.js");
 var EthiopicCal = require("./EthiopicCal.js");
 

js/lib/CopticDate.js

@@ -1,7 +1,7 @@
 /*
  * CopticDate.js - Represent a date in the Coptic calendar
  *
- * Copyright © 2015, 2018, JEDLSoft
+ * Copyright © 2015, 2018, 2023 JEDLSoft
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,8 +19,6 @@
 
 var ilib = require("../index.js");
 var MathUtils = require("./MathUtils.js");
-
-var Locale = require("./Locale.js");
 var IDate = require("./IDate.js");
 
 var EthiopicDate = require("./EthiopicDate.js");

js/lib/DateFmt.js

@@ -1,7 +1,7 @@
 /*
  * DateFmt.js - Date formatter definition
  *
- * Copyright © 2012-2015, 2018, 2020 JEDLSoft
+ * Copyright © 2012-2015, 2018, 2020, 2023 JEDLSoft
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -126,7 +126,7 @@ var ISet = require("./ISet.js");
  * Default components, if this property is not specified, is "dmy". This property may be specified
  * but has no affect if the current formatter is for times only.<br><br>
  * As of ilib 12.0, you can now pass ICU style skeletons in this option similar to the ones you
- * get from <a href="http://icu-project.org/apiref/icu4c432/classDateTimePatternGenerator.html#aa30c251609c1eea5ad60c95fc497251e">DateTimePatternGenerator.getSkeleton()</a>.
+ * get from <a href="https://unicode-org.github.io/icu-docs/apidoc/dev/icu4c/classicu_1_1DateTimePatternGenerator.html#af59552a2922795b494f82ec230208e2e">DateTimePatternGenerator.getSkeleton()</a>.
  * It will not extract the length from the skeleton so you still need to pass the length property,
  * but it will extract the date components. <br><br>
  *
@@ -161,7 +161,7 @@ var ISet = require("./ISet.js");
  * a movie of 198 minutes.<br><br>
  * Default value if this property is not specified is "hma".<br><br>
  * As of ilib 12.0, you can now pass ICU style skeletons in this option similar to the ones you
- * get from <a href="http://icu-project.org/apiref/icu4c432/classDateTimePatternGenerator.html#aa30c251609c1eea5ad60c95fc497251e">DateTimePatternGenerator.getSkeleton()</a>.
+ * get from <a href="https://unicode-org.github.io/icu-docs/apidoc/dev/icu4c/classicu_1_1DateTimePatternGenerator.html#af59552a2922795b494f82ec230208e2e">DateTimePatternGenerator.getSkeleton()</a>.
  * It will not extract the length from the skeleton so you still need to pass the length property,
  * but it will extract the time components.
  *
@@ -718,7 +718,7 @@ DateFmt.prototype = {
         });
     },
     /**
-     * @protected
+     * @private
      * @param {string|{
      *         order:(string|{
      *             s:string,
@@ -780,7 +780,7 @@ DateFmt.prototype = {
     },
 
     /**
-     * @protected
+     * @private
      */
     _massageTemplate: function () {
         var i;
@@ -855,7 +855,7 @@ DateFmt.prototype = {
 
     /**
      * Convert the template into an array of date components separated by formatting chars.
-     * @protected
+     * @private
      * @param {string} template Format template to tokenize into components
      * @return {Array.<string>} a tokenized array of date format components
      */
@@ -897,7 +897,7 @@ DateFmt.prototype = {
     },
 
     /**
-     * @protected
+     * @private
      * @param {Object.<string, (string|{s:string,m:string,l:string,f:string})>} obj Object to search
      * @param {string} components Format components to search
      * @param {string} length Length of the requested format
@@ -924,7 +924,7 @@ DateFmt.prototype = {
     },
 
     /**
-     * @protected
+     * @private
      * @param {Object.<string, (string|{s:string,m:string,l:string,f:string})>} obj Object to search
      * @param {string} components Format components to search
      * @param {string} length Length of the requested format
@@ -944,7 +944,7 @@ DateFmt.prototype = {
     },
 
     /**
-     * @protected
+     * @private
      * @param {(string|{s:string,m:string,l:string,f:string})} obj Object to search
      * @param {string} length Length of the requested format
      * @return {(string|undefined)} the requested format

js/lib/EthiopicDate.js

@@ -1,7 +1,7 @@
 /*
  * EthiopicDate.js - Represent a date in the Ethiopic calendar
  *
- * Copyright © 2015, 2018, 2021 JEDLSoft
+ * Copyright © 2015, 2018, 2021, 2023 JEDLSoft
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -214,7 +214,7 @@ EthiopicDate.prototype.newRd = function (params) {
 
 /**
  * Return the year for the given RD
- * @protected
+ * @private
  * @param {number} rd RD to calculate from
  * @returns {number} the year for the RD
  */
@@ -226,7 +226,7 @@ EthiopicDate.prototype._calcYear = function(rd) {
 
 /**
  * Calculate date components for the given RD date.
- * @protected
+ * @private
  */
 EthiopicDate.prototype._calcDateComponents = function () {
     var remainder,