TypeDoc all the thngs

src/http/response/ViewResponseFactory.ts

@@ -3,13 +3,25 @@ import {ResponseFactory} from "./ResponseFactory";
 import {Request} from "../lifecycle/Request";
 import {ViewEngine} from "../../views/ViewEngine";
 
+/**
+ * Helper function that creates a new ViewResponseFactory to render the given view
+ * with the specified data.
+ * @param name
+ * @param data
+ */
 export function view(name: string, data?: {[key: string]: any}): ViewResponseFactory {
     return new ViewResponseFactory(name, data)
 }
 
+/**
+ * HTTP response factory that uses the ViewEngine service to render a view
+ * and send it as HTML.
+ */
 export class ViewResponseFactory extends ResponseFactory {
     constructor(
+        /** The name of the view to render. */
         public readonly viewName: string,
+        /** Optional data that should be passed to the view engine as params. */
         public readonly data?: {[key: string]: any}
     ) { super() }