Documentation - Write-IN/Write-In Wiki

Documentation


Introduction

The documentation tool that will be used for the project Write-In is - “swagger-jsdoc “. This library reads JSDoc-annotated source code and generates a documentation specification.


Installation

For using it, first install it as npm package using command

npm install swagger-jsdoc


System requirements

Node.js 12.x or higher versions


How to use

const swaggerJsdoc = require('swagger-jsdoc');


Example

Comment following JSDoc annotation in your desired file:

Source Code

For above source code generated documentation will be:

output documentation


Resources

To know more about JSDoc annotation visit: JSDoc