Improves/extends doc comments

Author: hoijui

htmlpreview.js

@@ -8,6 +8,8 @@
 	 * If the first parameter is a URL to a file on a known git forge,
 	 * returns the URL to the raw version of this file
 	 * (vs the HTML/Web view of it).
+	 * @returns {string} The raw version of the (git hosted) file URL
+	 *   requested to be previewed.
 	 *
 	 * NOTE: This function 1 of 2 that is git-forge specific.
 	 */
@@ -18,8 +20,11 @@
 	};
 
 	/**
-	 * Returns whether the given URL points to a file on a known git forge.
-	 * @param {string} url - Any URL
+	 * Indicates whether the given URL points to a file on a known git forge.
+	 * @param {string} url - Any URL,
+	 *   potentially pointing to a git hosted raw (plain-text) file
+	 * @returns {boolean} `true` if the given URL indeed does point
+	 *   to a git hosted raw file
 	 *
 	 * NOTE: This is function 2 of 2 that is git-forge specific.
 	 */
@@ -32,6 +37,7 @@
 	 * Returns whether the given URL points to an HTML file,
 	 * considering only the file extension.
 	 * @param {string} url - Any URL
+	 * @returns {boolean} 'true' if the given URL points to an HTML file.
 	 */
 	const isHtmlUrl = function (url) {
 		return (url.indexOf('.html') > 0 || url.indexOf('.htm') > 0);
@@ -40,6 +46,7 @@
 	/**
 	 * Returns the base URL of our service,
 	 * to which the git hosted file URL can be appended.
+	 * @returns {string} a URL representing the our service base.
 	 */
 	const getServiceBase = function () {
 		if (window.location) {
@@ -54,6 +61,7 @@
 	/**
 	 * Rewrite URL so it can be loaded using CORS proxy.
 	 * @param {string} url - Any URL
+	 * @returns {string} The re-routed (for preview) version of the provided URL
 	 */
 	const rewrite = function (url) {
 		return location.origin + location.pathname + '?' + url;
@@ -64,6 +72,7 @@
 	 * if it points to a file on a known git forge.
 	 * @param {object} obj - An object containing a property that is a URL
 	 * @param {string} prop - The name of the URL property
+	 * @returns {void}
 	 */
 	const rewriteCond = function (obj, prop) {
 		// Get absolute URL