Bladeren bron

add namespaces to docas

d98762625 7 jaren geleden
bovenliggende
commit
c96a1df8e1
2 gewijzigde bestanden met toevoegingen van 4 en 1 verwijderingen
  1. 3 1
      src/node/apiUtils.mjs
  2. 1 0
      test/tests/assertionHandler.mjs

+ 3 - 1
src/node/apiUtils.mjs

@@ -76,6 +76,7 @@ export function wrap(Operation) {
 
 /**
  * First draft
+ * @namespace Api
  * @param input
  * @param type
  */
@@ -89,7 +90,7 @@ export async function translateTo(input, type) {
 }
 
 /**
- *
+ * @namespace Api
  * @param searchTerm
  */
 export function search(searchTerm) {
@@ -117,6 +118,7 @@ function extractOperationInfo(Operation) {
 
 
 /**
+ * @namespace Api
  * @param {Object} operations - an object filled with operations.
  * @param {String} searchTerm - the name of the operation to get help for.
  * Case and whitespace are ignored in search.

+ 1 - 0
test/tests/assertionHandler.mjs

@@ -12,6 +12,7 @@
 /**
  * it - wrapper for assertions to provide a helpful description
  * to the TestRegister
+ * @namespace ApiTests
  * @param {String} description - The description of the test
  * @param {Function} assertion - The test
  *