Merge branch 'feature/5-sponsoring_contracts' of git.odit.services:lfk/document-server into feature/5-sponsoring_contracts

ref #5

src/PdfCreator.ts

@@ -14,6 +14,10 @@ export class PdfCreator {
     private templateDir = path.join(__dirname, '/templates');
     private browser;
 
+    /**
+     * Main constructor.
+     * Initializes i18n(ext), Handlebars and puppeteer.
+     */
     constructor() {
         i18next
             .use(Backend)
@@ -34,6 +38,11 @@ export class PdfCreator {
         });
     }
 
+    /**
+     * Generate sponsoring contract pdfs.
+     * @param runner The runner you want to generate the contracts for.
+     * @param locale The locale used for the contracts (default:en)
+     */
     public async generateSponsoringContract(runner: Runner, locale: string = "en"): Promise<any> {
         i18next.changeLanguage(locale);
         const template_source = fs.readFileSync(`${this.templateDir}/sponsoring_contract.html`, 'utf8');