Permalink
Browse files

Code comments changes.

  • Loading branch information...
1 parent 4621430 commit 959b0add1a7fcf4c833c1b5c7e534232858d53c2 @samyakbhuta committed May 29, 2013
Showing with 107 additions and 71 deletions.
  1. +75 −48 docs/underscore.gu.html
  2. +32 −23 lib/underscore.gu.js
@@ -24,9 +24,22 @@
<li id="section-1">
<div class="annotation">
- <div class="pilwrap ">
+ <div class="pilwrap for-h2">
<a class="pilcrow" href="#section-1">&#182;</a>
</div>
+ <h2>Module Setup</h2>
+
+ </div>
+
+ </li>
+
+
+ <li id="section-2">
+ <div class="annotation">
+
+ <div class="pilwrap ">
+ <a class="pilcrow" href="#section-2">&#182;</a>
+ </div>
</div>
@@ -35,11 +48,24 @@
</li>
- <li id="section-2">
+ <li id="section-3">
+ <div class="annotation">
+
+ <div class="pilwrap for-h2">
+ <a class="pilcrow" href="#section-3">&#182;</a>
+ </div>
+ <h2>Checkers</h2>
+
+ </div>
+
+ </li>
+
+
+ <li id="section-4">
<div class="annotation">
<div class="pilwrap ">
- <a class="pilcrow" href="#section-2">&#182;</a>
+ <a class="pilcrow" href="#section-4">&#182;</a>
</div>
<p>Checks if <code>aChar</code> is in Gujarati Unicode Character (GUC) range.</p>
@@ -56,31 +82,33 @@
</li>
- <li id="section-3">
+ <li id="section-5">
<div class="annotation">
<div class="pilwrap ">
- <a class="pilcrow" href="#section-3">&#182;</a>
+ <a class="pilcrow" href="#section-5">&#182;</a>
</div>
- <p>Checks if &#39;aChar&#39; holds any significance and is not any of the reserved character.
+ <p>Checks if <code>aChar</code> holds any significance and is not any of the reserved character.
e.g. &#39;\u0A80&#39; or &#39;\u0A84&#39; though falls in GUC range, doesn&#39;t have any significance or value.
-Complete list is as follows.
-&#39;\u0A80&#39;
-&#39;\u0A84&#39;
-&#39;\u0A8E&#39;
-&#39;\u0A92&#39;
-&#39;\u0AA9&#39;
-&#39;\u0AB1&#39;
-&#39;\u0AB4&#39;
-&#39;\u0ABA&#39;
-&#39;\u0ABB&#39;
-&#39;\u0AC6&#39;
-&#39;\u0ACA&#39;
-&#39;\u0ACE&#39;
-&#39;\u0ACF&#39;
-&#39;\u0AD1&#39; to &#39;\u0ADF&#39;
-&#39;\u0AE4&#39; to &#39;\u0AE5&#39;
-&#39;\u0AF2&#39; to &#39;\u0AFF&#39;</p>
+Complete list is as follows.</p>
+<ul>
+<li>&#39;\u0A80&#39;</li>
+<li>&#39;\u0A84&#39;</li>
+<li>&#39;\u0A8E&#39;</li>
+<li>&#39;\u0A92&#39;</li>
+<li>&#39;\u0AA9&#39;</li>
+<li>&#39;\u0AB1&#39;</li>
+<li>&#39;\u0AB4&#39;</li>
+<li>&#39;\u0ABA&#39;</li>
+<li>&#39;\u0ABB&#39;</li>
+<li>&#39;\u0AC6&#39;</li>
+<li>&#39;\u0ACA&#39;</li>
+<li>&#39;\u0ACE&#39;</li>
+<li>&#39;\u0ACF&#39;</li>
+<li>&#39;\u0AD1&#39; to &#39;\u0ADF&#39;</li>
+<li>&#39;\u0AE4&#39; to &#39;\u0AE5&#39;</li>
+<li>&#39;\u0AF2&#39; to &#39;\u0AFF&#39;</li>
+</ul>
</div>
@@ -105,14 +133,14 @@
</li>
- <li id="section-4">
+ <li id="section-6">
<div class="annotation">
<div class="pilwrap ">
- <a class="pilcrow" href="#section-4">&#182;</a>
+ <a class="pilcrow" href="#section-6">&#182;</a>
</div>
- <p>Checks if the character is a vowel character.
-For this check to pass, a character need to be either a explicit vowel character or a diacritical mark character signifying a vowel.</p>
+ <p>Checks if <code>aChar</code> is a vowel character.
+For this check to pass, a character need to be either a explicit vowel character or a vowel sign character signifying a vowel.</p>
</div>
@@ -131,13 +159,13 @@
</li>
- <li id="section-5">
+ <li id="section-7">
<div class="annotation">
<div class="pilwrap ">
- <a class="pilcrow" href="#section-5">&#182;</a>
+ <a class="pilcrow" href="#section-7">&#182;</a>
</div>
- <p>Checks if the character is a consonant character.
+ <p>Checks if <code>aChar</code> is a consonant character.
For this check to pass, a character need to be a consonant or Anusvara which represents a consonant.
Note : Dipthongs are considered consonants here.</p>
@@ -158,13 +186,13 @@
</li>
- <li id="section-6">
+ <li id="section-8">
<div class="annotation">
<div class="pilwrap ">
- <a class="pilcrow" href="#section-6">&#182;</a>
+ <a class="pilcrow" href="#section-8">&#182;</a>
</div>
- <p>Checks if the character is any of the dipthongs.</p>
+ <p>Checks if <code>aChar</code> is any of the dipthongs.</p>
</div>
@@ -183,13 +211,13 @@
</li>
- <li id="section-7">
+ <li id="section-9">
<div class="annotation">
<div class="pilwrap ">
- <a class="pilcrow" href="#section-7">&#182;</a>
+ <a class="pilcrow" href="#section-9">&#182;</a>
</div>
- <p>Checks if the character is any of the plosives.</p>
+ <p>Checks if <code>aChar</code> is any of the plosives.</p>
</div>
@@ -208,13 +236,13 @@
</li>
- <li id="section-8">
+ <li id="section-10">
<div class="annotation">
<div class="pilwrap ">
- <a class="pilcrow" href="#section-8">&#182;</a>
+ <a class="pilcrow" href="#section-10">&#182;</a>
</div>
- <p>Checks if the character is any of the fricatives.</p>
+ <p>Checks if <code>aChar</code> is any of the fricatives.</p>
</div>
@@ -235,25 +263,24 @@
</li>
- <li id="section-9">
+ <li id="section-11">
<div class="annotation">
- <div class="pilwrap for-h3">
- <a class="pilcrow" href="#section-9">&#182;</a>
+ <div class="pilwrap for-h2">
+ <a class="pilcrow" href="#section-11">&#182;</a>
</div>
- <h3>Exporting</h3>
-<hr>
+ <h2>Exporting</h2>
</div>
</li>
- <li id="section-10">
+ <li id="section-12">
<div class="annotation">
<div class="pilwrap ">
- <a class="pilcrow" href="#section-10">&#182;</a>
+ <a class="pilcrow" href="#section-12">&#182;</a>
</div>
<p>CommonJS module is defined</p>
@@ -269,11 +296,11 @@
</li>
- <li id="section-11">
+ <li id="section-13">
<div class="annotation">
<div class="pilwrap ">
- <a class="pilcrow" href="#section-11">&#182;</a>
+ <a class="pilcrow" href="#section-13">&#182;</a>
</div>
<p>Register as a named module with AMD.</p>
View
@@ -1,5 +1,11 @@
+// Module Setup
+// ------------
var _gu = {
+
+// Checkers
+// --------
+
// Checks if `aChar` is in Gujarati Unicode Character (GUC) range.
isInGUCRange : function (aChar) {
if ('\u0A80' <= aChar && aChar <= '\u0AFF') {
@@ -9,25 +15,27 @@ var _gu = {
}
},
- // Checks if 'aChar' holds any significance and is not any of the reserved character.
+
+ // Checks if `aChar` holds any significance and is not any of the reserved character.
// e.g. '\u0A80' or '\u0A84' though falls in GUC range, doesn't have any significance or value.
// Complete list is as follows.
- // '\u0A80'
- // '\u0A84'
- // '\u0A8E'
- // '\u0A92'
- // '\u0AA9'
- // '\u0AB1'
- // '\u0AB4'
- // '\u0ABA'
- // '\u0ABB'
- // '\u0AC6'
- // '\u0ACA'
- // '\u0ACE'
- // '\u0ACF'
- // '\u0AD1' to '\u0ADF'
- // '\u0AE4' to '\u0AE5'
- // '\u0AF2' to '\u0AFF'
+
+ // * '\u0A80'
+ // * '\u0A84'
+ // * '\u0A8E'
+ // * '\u0A92'
+ // * '\u0AA9'
+ // * '\u0AB1'
+ // * '\u0AB4'
+ // * '\u0ABA'
+ // * '\u0ABB'
+ // * '\u0AC6'
+ // * '\u0ACA'
+ // * '\u0ACE'
+ // * '\u0ACF'
+ // * '\u0AD1' to '\u0ADF'
+ // * '\u0AE4' to '\u0AE5'
+ // * '\u0AF2' to '\u0AFF'
isValidGUC : function (aChar) {
if (this.isInGUCRange(aChar)) {
if (aChar === '\u0A80' || aChar === '\u0A84' || aChar === '\u0A8E' || aChar === '\u0A92' ||
@@ -46,8 +54,8 @@ var _gu = {
}
},
- // Checks if the character is a vowel character.
- // For this check to pass, a character need to be either a explicit vowel character or a diacritical mark character signifying a vowel.
+ // Checks if `aChar` is a vowel character.
+ // For this check to pass, a character need to be either a explicit vowel character or a vowel sign character signifying a vowel.
isVowel : function (aChar) {
if (this.isValidGUC(aChar)) {
if (('\u0A85' <= aChar && aChar <= '\u0A94') || ('\u0ABD' <= aChar && aChar <= '\u0ACC')) {
@@ -60,7 +68,7 @@ var _gu = {
}
},
- // Checks if the character is a consonant character.
+ // Checks if `aChar` is a consonant character.
// For this check to pass, a character need to be a consonant or Anusvara which represents a consonant.
// Note : Dipthongs are considered consonants here.
isConsonant : function (aChar) {
@@ -75,7 +83,7 @@ var _gu = {
}
},
- // Checks if the character is any of the dipthongs.
+ // Checks if `aChar` is any of the dipthongs.
isDipthong : function (aChar) {
if (this.isValidGUC(aChar)) {
if (aChar === '\u0AAF' || aChar === '\u0AB2' || aChar === '\u0AB3' || aChar === '\u0AB5') {
@@ -88,7 +96,7 @@ var _gu = {
}
},
- // Checks if the character is any of the plosives.
+ // Checks if `aChar` is any of the plosives.
isPlosive : function (aChar) {
if (this.isValidGUC(aChar)) {
if (('\u0A95' <= aChar && aChar <= '\u0AAE') || (aChar === '\u0A82')) {
@@ -101,7 +109,7 @@ var _gu = {
}
},
- // Checks if the character is any of the fricatives.
+ // Checks if `aChar` is any of the fricatives.
isFricative : function (aChar) {
if (this.isValidGUC(aChar)) {
if ('\u0AB6' <= aChar && aChar <= '\u0AB8') {
@@ -117,6 +125,7 @@ var _gu = {
};
// Exporting
+// ---------
// CommonJS module is defined
if (typeof exports !== 'undefined') {

0 comments on commit 959b0ad

Please sign in to comment.