Documentation generation first steps

doc_generator/lib_docgenerator.js

@@ -1,5 +1,5 @@
-var doc = require("surveyjs-doc-generator");
-var ts = require("typescript");
+var doc = require('surveyjs-doc-generator');
+var ts = require('typescript');
 
 doc.generateDocumentation(process.argv.slice(2), {
     target: ts.ScriptTarget.ES5, module: ts.ModuleKind.CommonJS

package.json

@@ -5,7 +5,7 @@
     "test": "jest",
     "testDev": "jest --watch",
     "release": "standard-version --message \"Release: %s\" ",
-    "doc_gen": "node doc_generator/lib_docgenerator.js src/index.ts",
+    "doc_gen": "node doc_generator/lib_docgenerator.js src/entries/pdf.ts",
     "doc_update": "chmod +x ./docupdate_npm.sh && ./docupdate_npm.sh",
     "build_dev": "webpack --env.buildType dev --env.platform pdf",
     "build_prod": "npm run build_dev && webpack --env.buildType prod --env.platform pdf && npm run dts_clean",

src/event_handler/draw_canvas.ts

@@ -4,18 +4,27 @@ import { TextBrick } from '../pdf_render/pdf_text';
 import { TextBoldBrick } from '../pdf_render/pdf_textbold';
 import { SurveyHelper } from '../helper_survey';
 
+/**
+ * Horizontal alignment types in onRenderHeader and onRenderFooter events
+ */
 export enum HorizontalAlign {
     NotSet = 'notset',
     Left = 'left',
     Center = 'center',
     Right = 'right'
 }
+/**
+ * Vertical alignment types in onRenderHeader and onRenderFooter events
+ */
 export enum VerticalAlign {
     NotSet = 'notset',
     Top = 'top',
     Middle = 'middle',
     Bottom = 'bottom'
 }
+/**
+ * Common options of rendering text and images in onRenderHeader and onRenderFooter events
+ */
 export interface IDrawRectOptions {
     /**
      * Specifies horizontal alignment of item, if set (center by default)
@@ -34,6 +43,9 @@ export interface IDrawRectOptions {
      */
     rect?: IRect;
 }
+/**
+ * Options of rendering text in onRenderHeader and onRenderFooter events
+ */
 export interface IDrawTextOptions extends IDrawRectOptions {
     /**
      * String that will be drawn
@@ -48,6 +60,9 @@ export interface IDrawTextOptions extends IDrawRectOptions {
      */
     isBold?: boolean;
 }
+/**
+ * Options of rendering images in onRenderHeader and onRenderFooter events
+ */
 export interface IDrawImageOptions extends IDrawRectOptions {
     /**
      * Specifies image width (used if alignment set, canvas.rect's width by default)
@@ -62,6 +77,10 @@ export interface IDrawImageOptions extends IDrawRectOptions {
      */
     base64: string;
 }
+
+/**
+ * DrawCanvas object passed to onRenderHeader and onRenderFooter events
+ */
 export class DrawCanvas {
     public static readonly DEFAULT_FONT_SIZE: number = 14;
     public constructor(protected packs: IPdfBrick[],

src/survey.ts

@@ -8,6 +8,9 @@ import { DrawCanvas } from './event_handler/draw_canvas';
 import { AdornersOptions } from './event_handler/adorners';
 import { SurveyHelper } from './helper_survey';
 
+/**
+ * SurveyPDF object contains options, events and methods to export PDF
+ */
 export class SurveyPDF extends SurveyModel {
   private _haveCommercialLicense: boolean;
   public options: IDocOptions;