jgaunt/CyberChef
2
0
Fork 0
mirror of https://github.com/gchq/CyberChef synced 2025-12-10 21:33:36 +00:00
Code Issues Releases Wiki Activity

add namespaces to docas

Browse Source
This commit is contained in:
d98762625
2018-05-11 11:09:04 +01:00
parent 5efc3f15f2
commit c96a1df8e1
2 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/node/apiUtils.mjs
View File

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

1
test/tests/assertionHandler.mjs
View File

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