diff --git a/jsdoc.json b/jsdoc.json new file mode 100644 index 0000000..b305cb3 --- /dev/null +++ b/jsdoc.json @@ -0,0 +1,38 @@ +{ + "tags": { + "allowUnknownTags": true + }, + "source": { + "include": ["./src"], + "includePattern": ".js$", + "excludePattern": "(node_modules/|docs)" + }, + "plugins": [ + "plugins/markdown" + ], + "opts": { + "encoding": "utf8", + "destination": "docs/", + "recurse": true, + "verbose": true, + "template": "better-docs" + }, + "templates": { + "cleverLinks": false, + "monospaceLinks": false, + "search": true, + "better-docs": { + "name": "Sample Documentation", + "title": "Test", // HTML title + "css": "style.css", + "trackingCode": "tracking-code-which-will-go-to-the-HEAD", + "hideGenerator": false, + "navLinks": [ + { + "label": "Git", + "href": "https://git.ssh.surf/MiTask/LinkUp-Bot-Lib" + } + ] + } + } +} \ No newline at end of file diff --git a/package.json b/package.json index 4a29f32..e3b41f3 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,13 @@ { "name": "linkup-bot-lib", "version": "1.0.0", - "main": "Client.js", + "main": "src/Client.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "keywords": [], "author": "", + "type": "module", "license": "ISC", "description": "", "dependencies": { @@ -15,5 +16,8 @@ "hyperdrive": "^11.8.1", "hyperswarm": "^4.7.15", "serve-drive": "^5.0.8" + }, + "devDependencies": { + "jsdoc": "^4.0.3" } } diff --git a/Client.js b/src/Client.js similarity index 99% rename from Client.js rename to src/Client.js index 6a48679..d926531 100644 --- a/Client.js +++ b/src/Client.js @@ -12,6 +12,9 @@ import Hyperdrive from 'hyperdrive'; import fs from 'fs'; import ServeDrive from 'serve-drive'; +/** + * @author Raven + */ class Client extends EventEmitter { constructor(botName) { super(); diff --git a/message/AudioMessage.js b/src/message/AudioMessage.js similarity index 100% rename from message/AudioMessage.js rename to src/message/AudioMessage.js diff --git a/message/FileMessage.js b/src/message/FileMessage.js similarity index 100% rename from message/FileMessage.js rename to src/message/FileMessage.js diff --git a/message/IconMessage.js b/src/message/IconMessage.js similarity index 100% rename from message/IconMessage.js rename to src/message/IconMessage.js diff --git a/message/Message.js b/src/message/Message.js similarity index 100% rename from message/Message.js rename to src/message/Message.js diff --git a/message/TextMessage.js b/src/message/TextMessage.js similarity index 100% rename from message/TextMessage.js rename to src/message/TextMessage.js