Fix JSDoc tags for full documentation

kafiarifin · May 31, 2016 · 40cbd89 · 40cbd89
1 parent e120370
commit 40cbd89
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 8 deletions.
diff --git a/core/bn.js b/core/bn.js
@@ -1,6 +1,6 @@
 /**
- * @constructor
  * Constructs a new bignum from another bignum, a number or a hex string.
+ * @constructor
  */
 sjcl.bn = function(it) {
   this.initWith(it);

diff --git a/core/cbc.js b/core/cbc.js
@@ -10,9 +10,9 @@ if (sjcl.beware === undefined) {
 }
 sjcl.beware["CBC mode is dangerous because it doesn't protect message integrity."
 ] = function() {
-  /** @namespace
+  /**
    * Dangerous: CBC mode with PKCS#5 padding.
-   *
+   * @namespace
    * @author Emily Stark
    * @author Mike Hamburg
    * @author Dan Boneh

diff --git a/core/ccmArrayBuffer.js b/core/ccmArrayBuffer.js
@@ -3,8 +3,10 @@
  * @author Marco Munizaga
  */
 
-/** @namespace CTR mode with CBC MAC. */
-
+/**
+ * CTR mode with CBC MAC.
+ * @namespace
+ */
 sjcl.arrayBuffer = sjcl.arrayBuffer || {};
 
 //patch arraybuffers if they don't exist

diff --git a/core/codecBytes.js b/core/codecBytes.js
@@ -5,7 +5,10 @@
  * @author Dan Boneh
  */
 
-/** @namespace Arrays of bytes */
+/**
+ * Arrays of bytes
+ * @namespace
+ */
 sjcl.codec.bytes = {
   /** Convert from a bitArray to an array of bytes. */
   fromBits: function (arr) {

diff --git a/core/ctr.js b/core/ctr.js
@@ -8,9 +8,9 @@ if (sjcl.beware === undefined) {
 }
 sjcl.beware["CTR mode is dangerous because it doesn't protect message integrity."
 ] = function() {
-  /** @namespace
+  /**
    * Dangerous: CTR mode.
-   *
+   * @namespace
    * @author Torben Haase
    */
   sjcl.mode.ctr = {