Add module designations to documented modules

JSDoc is pretty terrible about organizing the code it documents, but module designations help clean it up. Signed-off-by: Zac Delventhal <[email protected]>
hyperledger-archives · Jun 27, 2018 · 7737826 · 7737826
1 parent 6beb6ca
commit 7737826
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 0 deletions.
diff --git a/processor/context.js b/processor/context.js
@@ -15,6 +15,7 @@
  * ------------------------------------------------------------------------------
  */
 
+/** @module processor/context */
 'use strict'
 
 const {

diff --git a/processor/exceptions.js b/processor/exceptions.js
@@ -15,6 +15,7 @@
  * ------------------------------------------------------------------------------
  */
 
+/** @module processor/exceptions */
 'use strict'
 
 class _TransactionProcessorError extends Error {

diff --git a/processor/handler.js b/processor/handler.js
@@ -15,6 +15,7 @@
  * ------------------------------------------------------------------------------
  */
 
+/** @module processor/handler */
 'use strict'
 
 /**

diff --git a/processor/index.js b/processor/index.js
@@ -15,6 +15,7 @@
  * ------------------------------------------------------------------------------
  */
 
+/** @module processor */
 'use strict'
 
 const {

diff --git a/protobuf/index.js b/protobuf/index.js
@@ -15,6 +15,7 @@
  * ------------------------------------------------------------------------------
  */
 
+/** @module protobuf */
 'use strict'
 
 const protobuf = require('protobufjs')

diff --git a/signing/core.js b/signing/core.js
@@ -15,6 +15,7 @@
  * ------------------------------------------------------------------------------
  */
 
+/** @module signing/core */
 'use strict'
 
 /**

diff --git a/signing/index.js b/signing/index.js
@@ -15,6 +15,7 @@
  * ------------------------------------------------------------------------------
  */
 
+/** @module signing */
 'use strict'
 
 const { NoSuchAlgorithmError, SigningError, ParseError } = require('./core')

diff --git a/signing/secp256k1.js b/signing/secp256k1.js
@@ -15,6 +15,7 @@
  * ------------------------------------------------------------------------------
  */
 
+/** @module signing/secp256k1 */
 'use strict'
 
 const secp256k1 = require('secp256k1')
-Original file line number
+Diff line change
@@ Expand Up / @@ -15,6 +15,7 @@ @@
      * ------------------------------------------------------------------------------
      */
+    /** @module processor/context */
     'use strict'
     const {
@@ Expand Down @@