From: Timo Tijhof <krinklemail@gmail.com>
Date: Sun, 27 Apr 2014 14:26:54 +0000 (+0200)
Subject: jquery.byteLength: Add jsduck documentation
X-Git-Tag: 1.31.0-rc.0~15977^2
X-Git-Url: https://git.cyclocoop.org/admin/?a=commitdiff_plain;h=aa34a718df61ed7ea395477120b7dfe298c4a819;p=lhc%2Fweb%2Fwiklou.git

jquery.byteLength: Add jsduck documentation

Change-Id: Iee8a5c930b6d2dcb0f5a66aca04e9b18c755d787
---

diff --git a/maintenance/jsduck/config.json b/maintenance/jsduck/config.json
index d203bafa2c..6f91cadd52 100644
--- a/maintenance/jsduck/config.json
+++ b/maintenance/jsduck/config.json
@@ -19,6 +19,7 @@
 		"../../resources/src/jquery/jquery.arrowSteps.js",
 		"../../resources/src/jquery/jquery.autoEllipsis.js",
 		"../../resources/src/jquery/jquery.badge.js",
+		"../../resources/src/jquery/jquery.byteLength.js",
 		"../../resources/src/jquery/jquery.byteLimit.js",
 		"../../resources/src/jquery/jquery.client.js",
 		"../../resources/src/jquery/jquery.colorUtil.js",
diff --git a/resources/src/jquery/jquery.byteLength.js b/resources/src/jquery/jquery.byteLength.js
index 398937e6c0..0b8f9daf1f 100644
--- a/resources/src/jquery/jquery.byteLength.js
+++ b/resources/src/jquery/jquery.byteLength.js
@@ -1,14 +1,16 @@
 /**
- * jQuery.byteLength
- *
- * Calculate the byte length of a string (accounting for UTF-8).
- *
+ * @class jQuery.plugin.byteLength
  * @author Jan Paul Posma, 2011
  * @author Timo Tijhof, 2012
  * @author David Chan, 2013
  */
-jQuery.byteLength = function ( str ) {
 
+/**
+ * Calculate the byte length of a string (accounting for UTF-8).
+ *
+ * @static
+ */
+jQuery.byteLength = function ( str ) {
 	// This basically figures out how many bytes a UTF-16 string (which is what js sees)
 	// will take in UTF-8 by replacing a 2 byte character with 2 *'s, etc, and counting that.
 	// Note, surrogate (\uD800-\uDFFF) characters are counted as 2 bytes, since there's two of them
@@ -27,5 +29,9 @@ jQuery.byteLength = function ( str ) {
 		.replace( /[\u0080-\u07FF\uD800-\uDFFF]/g, '**' )
 		.replace( /[\u0800-\uD7FF\uE000-\uFFFF]/g, '***' )
 		.length;
-
 };
+
+/**
+ * @class jQuery
+ * @mixins jQuery.plugin.byteLength
+ */