Adds documentations for adapters and main constructors (#4951)

* wip

* Adds documentations for adapters, and constructors

* nits

* nit
This commit is contained in:
Florent Vilmart
2018-08-10 15:51:31 -04:00
parent 0571675fcd
commit 942b9b5b1a
17 changed files with 3316 additions and 2708 deletions

View File

@@ -1,10 +1,14 @@
/*eslint no-unused-vars: "off"*/
/*
Mail Adapter prototype
A MailAdapter should implement at least sendMail()
/**
* @module Adapters
*/
/**
* @interface MailAdapter
* Mail Adapter prototype
* A MailAdapter should implement at least sendMail()
*/
export class MailAdapter {
/*
/**
* A method for sending mail
* @param options would have the parameters
* - to: the recipient