(#87) generateOutputPath API docs

Author: s1hofmann

Diff for: lib/generate-output-path.function.ts

@@ -2,6 +2,11 @@ import { join, parse } from "path";
 import { cwd } from "process";
 import { FileType } from "./file-type.enum";
 
+/**
+ * {@link generateOutputPath} is used to assemble full file path from a filename and various parameters
+ * @param filename The base filename
+ * @param params A config object which allows to configure {@link FileType}, base path, filename prefix and filename postfix
+ */
 export const generateOutputPath = (
   filename: string,
   params?: {