From cf0da1f4e05d782bd073309783aa1580b8036b5b Mon Sep 17 00:00:00 2001 From: Dennis Eichhorn Date: Sat, 3 Jun 2017 21:30:17 +0200 Subject: [PATCH] Added function documentation --- Utils/oLib.js | 52 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/Utils/oLib.js b/Utils/oLib.js index 2a47dbf..f30c3f7 100644 --- a/Utils/oLib.js +++ b/Utils/oLib.js @@ -9,21 +9,73 @@ { "use strict"; + /** + * Trim char from string + * + * @param {string} str String to trim from + * @param {string} char Char to trim + * + * @return {string} + * + * @function + * + * @since 1.0.0 + * @author Dennis Eichhorn + */ jsOMS.trim = function(str, char) { return jsOMS.ltrim(jsOMS.rtrim(str, char), char); }; + /** + * Trim char from right part of string + * + * @param {string} str String to trim from + * @param {string} char Char to trim + * + * @return {string} + * + * @function + * + * @since 1.0.0 + * @author Dennis Eichhorn + */ jsOMS.rtrim = function(str, char) { return str.replace(new RegExp("[" + char + "]*$"), ''); }; + /** + * Trim char from left part of string + * + * @param {string} str String to trim from + * @param {string} char Char to trim + * + * @return {string} + * + * @function + * + * @since 1.0.0 + * @author Dennis Eichhorn + */ jsOMS.ltrim = function(str, char) { return str.replace(new RegExp("^[" + char + "]*"), ''); }; + /** + * Count string in string + * + * @param {string} str String to inspect + * @param {string} substr Substring to count + * + * @return {int} + * + * @function + * + * @since 1.0.0 + * @author Dennis Eichhorn + */ jsOMS.substr_count = function(str, substr) { str += ''; substr += '';