@terafina/tffa-sfdx-plugin 0.1.2 → 1.0.1

package/lib/apexdoc/engine/generators/models/method-markup-generator.d.ts

@@ -0,0 +1,22 @@
+import MarkupGenerator from './markup-generator';
+import { ClassModel, MethodModel, TopLevelModel } from '../../../common/models';
+declare class MethodMarkupGenerator extends MarkupGenerator<MethodModel> {
+    protected constructor(model: MethodModel, models: Map<string, TopLevelModel>);
+    static generate(cModel: ClassModel, models: Map<string, TopLevelModel>): string;
+    private static generateSection;
+    protected markupTemplate(label: string, contents: string, titleClass?: string, contentClass?: string, tag?: string): string;
+    protected author(): string;
+    protected header(id: string, topmostTypeName: string): string;
+    protected since(): string;
+    protected exception(): string;
+    protected params(): string;
+    protected returns(): string;
+    protected getTOCEntry(showTOCSnippets: boolean, id: string): string;
+    /**
+     * See if method ID has been used previously in this class
+     * (must be an overloaded method or constructor) and amend
+     * as needed to ensure all of our methods have unique IDs
+     */
+    protected generateMethodId(idCountMap: Map<string, number>, classModel: ClassModel): string;
+}
+export default MethodMarkupGenerator;

package/lib/apexdoc/engine/generators/models/method-markup-generator.js

@@ -0,0 +1,224 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/**
+ * Copyright (c) NCR Terafina
+ **/
+const generator_utils_1 = tslib_1.__importDefault(require("../generator-utils"));
+const markup_generator_1 = tslib_1.__importDefault(require("./markup-generator"));
+const settings_1 = tslib_1.__importDefault(require("../../../common/settings"));
+class MethodMarkupGenerator extends markup_generator_1.default {
+    constructor(model, models) {
+        super(model, models);
+    }
+    static generate(cModel, models) {
+        // retrieve methods to work with in the order user specifies
+        const allMethods = settings_1.default.config.sortOrder === settings_1.default.ORDER_ALPHA ? cModel.methodsSorted : cModel.methods;
+        const constructors = allMethods.filter(m => m.isConstructor);
+        const methods = allMethods.filter(m => !m.isConstructor);
+        const constructorsMarkup = constructors.length ? this.generateSection('Constructors', constructors, cModel, models) : '';
+        const methodsMarkup = methods.length ? this.generateSection('Methods', methods, cModel, models) : '';
+        return constructorsMarkup + methodsMarkup;
+    }
+    static generateSection(section, methods, cModel, models) {
+        // track Ids used to make sure we're not generating duplicate
+        // ids within this class and so that overloaded methods each
+        // have their own unique anchor to link to in the TOC.
+        const idCountMap = new Map();
+        // initialize a couple of strings to house our markup
+        let tocMarkup = '';
+        let methodsMarkup = '';
+        // full method display
+        for (const method of methods) {
+            // instantiate our markup generator
+            const generator = new MethodMarkupGenerator(method, models);
+            // generate unique method id
+            const methodId = generator.generateMethodId(idCountMap, cModel);
+            // make our TOC entry, we'll concat this with the rest of the markup in the proper order later
+            tocMarkup += generator.getTOCEntry(settings_1.default.config.showTOCSnippets, methodId);
+            // run our generators in the desired order
+            let methodMarkup = '';
+            methodMarkup += generator.header(methodId, cModel.topMostClassName);
+            methodMarkup += generator.description('method-description');
+            methodMarkup += generator.signature('method');
+            methodMarkup += generator.deprecated();
+            methodMarkup += generator.api();
+            methodMarkup += generator.params();
+            methodMarkup += generator.returns();
+            methodMarkup += generator.exception();
+            methodMarkup += generator.see();
+            methodMarkup += generator.author();
+            methodMarkup += generator.since();
+            methodMarkup += generator.example();
+            // add method markup to our running methodsMarkup string
+            methodsMarkup += `<div class="method ${method.scope}">${methodMarkup}</div>`;
+        }
+        // concat and close TOC and full methods display HTML
+        const markup = `<div class="subsection methods">
+                <h3 class="subsection-title methods">${cModel.name} ${section}</h3>
+                <div class="methods-container">
+                    <ul class="methods-toc">${tocMarkup}</ul>
+                    ${methodsMarkup}
+                </div>
+            </div>`;
+        return markup;
+    }
+    markupTemplate(label, contents, titleClass = '', contentClass = 'method-subtitle-description', tag = 'div') {
+        titleClass = titleClass ? `method-subtitle ${titleClass}` : 'method-subtitle';
+        return super.markupTemplate(label, contents, titleClass, contentClass, tag);
+    }
+    author() {
+        if (!this.model.author) {
+            return '';
+        }
+        else {
+            return this.markupTemplate('Author', generator_utils_1.default.encodeText(this.model.author, true, this.models));
+        }
+    }
+    header(id, topmostTypeName) {
+        return `
+            <h4 class="method-title ${this.model.deprecated ? 'deprecated' : ''}" id="${id}">
+                ${super.linkToSource(`${this.model.name}(${this.model.paramsFromNameLine.join(', ')})`, topmostTypeName)}
+            </h4>`;
+    }
+    since() {
+        if (!this.model.since) {
+            return '';
+        }
+        else {
+            return this.markupTemplate('Since', generator_utils_1.default.encodeText(this.model.since, true, this.models));
+        }
+    }
+    exception() {
+        let markup = '';
+        if (this.model.exception.length) {
+            markup += '<div class="method-subtitle">Exception</div>';
+            for (const { description, type } of this.model.exception) {
+                if (type) {
+                    markup += `<div class="param-type">
+                        Type: <code class="code-inline">${type}</code>
+                    </div>`;
+                }
+                if (description) {
+                    markup += `<div class="param-description">${description}</div>`;
+                }
+            }
+        }
+        return markup;
+    }
+    params() {
+        let markup = '';
+        if (this.model.params && this.model.params.length > 0) {
+            markup += '<div class="method-subtitle">Parameters</div>';
+            for (const { name, description, type } of this.model.params) {
+                markup += `<div class="param-name">${name}</div>`;
+                if (type) {
+                    markup += `<div class="param-type">
+                        Type: <code class="code-inline">${type}</code>
+                    </div>`;
+                }
+                if (description) {
+                    markup += `<div class="param-description">${description}</div>`;
+                }
+            }
+        }
+        if (this.model.queryparams && this.model.queryparams.length > 0) {
+            markup += '<div class="method-subtitle">Query Parameters</div>';
+            for (const { name, description, type, required } of this.model.queryparams) {
+                markup += `<div class="param-name">${name}</div>`;
+                if (type) {
+                    markup += `<div class="param-type">
+                        Type: <code class="code-inline">${type}</code>
+                    </div>`;
+                }
+                markup += `<div class="param-type">
+                        Required: <code class="code-inline">${required}</code>
+                    </div>`;
+                if (description) {
+                    markup += `<div class="param-description">${description}</div>`;
+                }
+            }
+        }
+        if (this.model.requestheaders && this.model.requestheaders.length > 0) {
+            markup += '<div class="method-subtitle">Request Headers</div>';
+            for (const { name, description, type, required } of this.model.requestheaders) {
+                markup += `<div class="param-name">${name}</div>`;
+                if (type) {
+                    markup += `<div class="param-type">
+                        Type: <code class="code-inline">${type}</code>
+                    </div>`;
+                }
+                markup += `<div class="param-type">
+                        Required: <code class="code-inline">${required}</code>
+                    </div>`;
+                if (description) {
+                    markup += `<div class="param-description">${description}</div>`;
+                }
+            }
+        }
+        if (this.model.responseheaders && this.model.responseheaders.length > 0) {
+            markup += '<div class="method-subtitle">Response Headers</div>';
+            for (const { name, description, type, required } of this.model.responseheaders) {
+                markup += `<div class="param-name">${name}</div>`;
+                if (type) {
+                    markup += `<div class="param-type">
+                        Type: <code class="code-inline">${type}</code>
+                    </div>`;
+                }
+                markup += `<div class="param-type">
+                        Required: <code class="code-inline">${required}</code>
+                    </div>`;
+                if (description) {
+                    markup += `<div class="param-description">${description}</div>`;
+                }
+            }
+        }
+        return markup;
+    }
+    returns() {
+        const returns = this.model.returns;
+        let markup = '';
+        if (returns && (returns.description || returns.type)) {
+            markup += '<div class="method-subtitle">Returns</div>';
+            if (returns.type) {
+                const type = generator_utils_1.default.encodeText(returns.type, false);
+                markup += `<div class="param-type">
+                            Type: <code class="code-inline">${type}</code>
+                        </div>`;
+            }
+            if (returns.description) {
+                const description = generator_utils_1.default.encodeText(returns.description, false);
+                markup += `<div class="param-description">${description}</div>`;
+            }
+        }
+        return markup;
+    }
+    getTOCEntry(showTOCSnippets, id) {
+        const entry = `<li class="method ${this.model.scope}">
+                <a class="methods-toc__entry ${this.model.deprecated ? 'deprecated' : ''}" href="#${id}">
+                    ${this.model.name} (${this.model.paramsFromNameLine.join(', ')})
+                </a>
+                ${showTOCSnippets && this.model.description ? this.description('methods-toc__description') : ''}
+            </li>`;
+        return entry;
+    }
+    /**
+     * See if method ID has been used previously in this class
+     * (must be an overloaded method or constructor) and amend
+     * as needed to ensure all of our methods have unique IDs
+     */
+    generateMethodId(idCountMap, classModel) {
+        let methodId = classModel.name + '.' + this.model.name;
+        let count;
+        if ((count = idCountMap.get(methodId)) === undefined) {
+            idCountMap.set(methodId, 1);
+        }
+        else {
+            idCountMap.set(methodId, count + 1);
+            methodId += '_' + count;
+        }
+        return methodId;
+    }
+}
+exports.default = MethodMarkupGenerator;
+//# sourceMappingURL=method-markup-generator.js.map

package/lib/apexdoc/engine/generators/models/method-markup-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"method-markup-generator.js","sourceRoot":"","sources":["../../../../../src/apexdoc/engine/generators/models/method-markup-generator.ts"],"names":[],"mappings":";;;AAAA;;IAEI;AACJ,iFAAgD;AAChD,kFAAiD;AAGjD,gFAAgD;AAEhD,MAAM,qBAAsB,SAAQ,0BAA4B;IAC9D,YAAsB,KAAkB,EAAE,MAAkC;QAC1E,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,MAAkB,EAAE,MAAkC;QAC3E,4DAA4D;QAC5D,MAAM,UAAU,GAAG,kBAAQ,CAAC,MAAM,CAAC,SAAS,KAAK,kBAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;QAE9G,MAAM,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;QAC7D,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;QAEzD,MAAM,kBAAkB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,cAAc,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAEzH,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAErG,OAAO,kBAAkB,GAAG,aAAa,CAAC;IAC5C,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,OAAe,EAAE,OAA2B,EAAE,MAAkB,EAAE,MAAkC;QACjI,6DAA6D;QAC7D,4DAA4D;QAC5D,sDAAsD;QACtD,MAAM,UAAU,GAAG,IAAI,GAAG,EAAkB,CAAC;QAE7C,qDAAqD;QACrD,IAAI,SAAS,GAAG,EAAE,CAAC;QACnB,IAAI,aAAa,GAAG,EAAE,CAAC;QAEvB,sBAAsB;QACtB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,mCAAmC;YACnC,MAAM,SAAS,GAAG,IAAI,qBAAqB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAE5D,4BAA4B;YAC5B,MAAM,QAAQ,GAAG,SAAS,CAAC,gBAAgB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAEhE,8FAA8F;YAC9F,SAAS,IAAI,SAAS,CAAC,WAAW,CAAC,kBAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;YAE9E,0CAA0C;YAC1C,IAAI,YAAY,GAAG,EAAE,CAAC;YACtB,YAAY,IAAI,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;YACpE,YAAY,IAAI,SAAS,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;YAC5D,YAAY,IAAI,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC9C,YAAY,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;YACvC,YAAY,IAAI,SAAS,CAAC,GAAG,EAAE,CAAC;YAChC,YAAY,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;YACnC,YAAY,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;YACpC,YAAY,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;YACtC,YAAY,IAAI,SAAS,CAAC,GAAG,EAAE,CAAC;YAChC,YAAY,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;YACnC,YAAY,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;YAClC,YAAY,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;YAEpC,wDAAwD;YACxD,aAAa,IAAI,sBAAsB,MAAM,CAAC,KAAK,KAAK,YAAY,QAAQ,CAAC;SAC9E;QAED,qDAAqD;QACrD,MAAM,MAAM,GAAG;uDACoC,MAAM,CAAC,IAAI,IAAI,OAAO;;8CAE/B,SAAS;sBACjC,aAAa;;mBAEhB,CAAC;QAEhB,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,cAAc,CAAC,KAAa,EAAE,QAAgB,EAAE,UAAU,GAAG,EAAE,EAAE,YAAY,GAAG,6BAA6B,EAAE,GAAG,GAAG,KAAK;QAClI,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,mBAAmB,UAAU,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC;QAC9E,OAAO,KAAK,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC;IAC9E,CAAC;IAES,MAAM;QACd,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YACtB,OAAO,EAAE,CAAC;SACX;aAAM;YACL,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,yBAAc,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;SACvG;IACH,CAAC;IAES,MAAM,CAAC,EAAU,EAAE,eAAuB;QAClD,OAAO;sCAC2B,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE;kBACxE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,eAAe,CAAC;kBACtG,CAAC;IACjB,CAAC;IAES,KAAK;QACb,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE;YACrB,OAAO,EAAE,CAAC;SACX;aAAM;YACL,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,yBAAc,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;SACrG;IACH,CAAC;IAES,SAAS;QACjB,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE;YAC/B,MAAM,IAAI,8CAA8C,CAAC;YACzD,KAAK,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;gBACxD,IAAI,IAAI,EAAE;oBACR,MAAM,IAAI;0DACsC,IAAI;2BACnC,CAAC;iBACnB;gBAED,IAAI,WAAW,EAAE;oBACf,MAAM,IAAI,kCAAkC,WAAW,QAAQ,CAAC;iBACjE;aACF;SACF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,MAAM;QACd,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACrD,MAAM,IAAI,+CAA+C,CAAC;YAC1D,KAAK,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;gBAC3D,MAAM,IAAI,2BAA2B,IAAI,QAAQ,CAAC;gBAElD,IAAI,IAAI,EAAE;oBACR,MAAM,IAAI;0DACsC,IAAI;2BACnC,CAAC;iBACnB;gBAED,IAAI,WAAW,EAAE;oBACf,MAAM,IAAI,kCAAkC,WAAW,QAAQ,CAAC;iBACjE;aACF;SACF;QACD,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/D,MAAM,IAAI,qDAAqD,CAAC;YAChE,KAAK,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE;gBAC1E,MAAM,IAAI,2BAA2B,IAAI,QAAQ,CAAC;gBAElD,IAAI,IAAI,EAAE;oBACR,MAAM,IAAI;0DACsC,IAAI;2BACnC,CAAC;iBACnB;gBAED,MAAM,IAAI;8DAC4C,QAAQ;2BAC3C,CAAC;gBAEpB,IAAI,WAAW,EAAE;oBACf,MAAM,IAAI,kCAAkC,WAAW,QAAQ,CAAC;iBACjE;aACF;SACF;QAED,IAAI,IAAI,CAAC,KAAK,CAAC,cAAc,IAAI,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;YACrE,MAAM,IAAI,oDAAoD,CAAC;YAC/D,KAAK,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE;gBAC7E,MAAM,IAAI,2BAA2B,IAAI,QAAQ,CAAC;gBAElD,IAAI,IAAI,EAAE;oBACR,MAAM,IAAI;0DACsC,IAAI;2BACnC,CAAC;iBACnB;gBAED,MAAM,IAAI;8DAC4C,QAAQ;2BAC3C,CAAC;gBAEpB,IAAI,WAAW,EAAE;oBACf,MAAM,IAAI,kCAAkC,WAAW,QAAQ,CAAC;iBACjE;aACF;SACF;QACD,IAAI,IAAI,CAAC,KAAK,CAAC,eAAe,IAAI,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE;YACvE,MAAM,IAAI,qDAAqD,CAAC;YAChE,KAAK,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE;gBAC9E,MAAM,IAAI,2BAA2B,IAAI,QAAQ,CAAC;gBAElD,IAAI,IAAI,EAAE;oBACR,MAAM,IAAI;0DACsC,IAAI;2BACnC,CAAC;iBACnB;gBAED,MAAM,IAAI;8DAC4C,QAAQ;2BAC3C,CAAC;gBAEpB,IAAI,WAAW,EAAE;oBACf,MAAM,IAAI,kCAAkC,WAAW,QAAQ,CAAC;iBACjE;aACF;SACF;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,OAAO;QACf,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;QACnC,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;YACpD,MAAM,IAAI,4CAA4C,CAAC;YACvD,IAAI,OAAO,CAAC,IAAI,EAAE;gBAChB,MAAM,IAAI,GAAG,yBAAc,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAE5D,MAAM,IAAI;8DAC4C,IAAI;+BACnC,CAAC;aACzB;YACD,IAAI,OAAO,CAAC,WAAW,EAAE;gBACvB,MAAM,WAAW,GAAG,yBAAc,CAAC,UAAU,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;gBAC1E,MAAM,IAAI,kCAAkC,WAAW,QAAQ,CAAC;aACjE;SACF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,WAAW,CAAC,eAAwB,EAAE,EAAU;QACxD,MAAM,KAAK,GAAG,qBAAqB,IAAI,CAAC,KAAK,CAAC,KAAK;+CACR,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE;sBAChF,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC;;kBAEhE,eAAe,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,EAAE;kBAC7F,CAAC;QAEf,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACO,gBAAgB,CAAC,UAA+B,EAAE,UAAsB;QAChF,IAAI,QAAQ,GAAG,UAAU,CAAC,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QACvD,IAAI,KAAqB,CAAC;QAC1B,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,KAAK,SAAS,EAAE;YACpD,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;SAC7B;aAAM;YACL,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;YACpC,QAAQ,IAAI,GAAG,GAAG,KAAK,CAAC;SACzB;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AAED,kBAAe,qBAAqB,CAAC"}

package/lib/apexdoc/engine/generators/models/property-markup-generator.d.ts

@@ -0,0 +1,11 @@
+import MarkupGenerator from './markup-generator';
+import { ClassModel, PropertyModel, TopLevelModel } from '../../../common/models';
+declare class PropertyMarkupGenerator extends MarkupGenerator<PropertyModel> {
+    protected constructor(model: PropertyModel, models: Map<string, TopLevelModel>);
+    static generate(cModel: ClassModel, models: Map<string, TopLevelModel>): string;
+    protected static hasDescriptionColumn(headerRow: string): boolean;
+    protected static hasAnnotationsColumn(headerRow: string): boolean;
+    protected static headerRow(properties: Array<PropertyModel>): string;
+    protected propRow(topmostTypeName: string, hasAnnotationsColumn: boolean, hasDescriptionColumn: boolean): string;
+}
+export default PropertyMarkupGenerator;

package/lib/apexdoc/engine/generators/models/property-markup-generator.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/**
+ * Copyright (c) NCR Terafina
+ **/
+const generator_utils_1 = tslib_1.__importDefault(require("../generator-utils"));
+const markup_generator_1 = tslib_1.__importDefault(require("./markup-generator"));
+const settings_1 = tslib_1.__importDefault(require("../../../common/settings"));
+class PropertyMarkupGenerator extends markup_generator_1.default {
+    constructor(model, models) {
+        super(model, models);
+    }
+    static generate(cModel, models) {
+        const properties = settings_1.default.config.sortOrder === settings_1.default.ORDER_ALPHA ? cModel.propertiesSorted : cModel.properties;
+        let markup = PropertyMarkupGenerator.headerRow(properties);
+        const hasAnnotations = PropertyMarkupGenerator.hasAnnotationsColumn(markup);
+        const hasDescription = PropertyMarkupGenerator.hasDescriptionColumn(markup);
+        for (const prop of properties) {
+            const generator = new PropertyMarkupGenerator(prop, models);
+            markup += generator.propRow(cModel.topMostClassName, hasAnnotations, hasDescription);
+        }
+        markup = `<div class="subsection properties ${cModel.name.replace('.', '_')}">
+                <h3 class="subsection-title properties">${cModel.name} Properties</h2>
+                <table class="attributes-table properties">
+                    ${markup}
+                </table>
+            </div>`;
+        return markup;
+    }
+    static hasDescriptionColumn(headerRow) {
+        return /<th>Description<\/th>/.test(headerRow);
+    }
+    static hasAnnotationsColumn(headerRow) {
+        return /<th>Annotations<\/th>/.test(headerRow);
+    }
+    static headerRow(properties) {
+        let descriptionCol = '', annotationsCol = '';
+        properties.forEach(prop => {
+            prop.description && (descriptionCol = '<th>Description</th>');
+            prop.annotations.length && (annotationsCol = '<th>Annotations</th>');
+        });
+        return `
+            <tr>
+                <th>Name</th>
+                <th>Signature</th>
+                ${annotationsCol}
+                ${descriptionCol}
+            </tr>`;
+    }
+    propRow(topmostTypeName, hasAnnotationsColumn, hasDescriptionColumn) {
+        return `
+            <tr class="property ${this.model.scope}">
+                <td class="attribute-name">${super.linkToSource(this.model.name, topmostTypeName)}</td>
+                <td>
+                    <div class="attribute-signature">
+                        ${generator_utils_1.default.encodeText(this.model.nameLine)}
+                    </div>
+                </td>
+                ${hasAnnotationsColumn ? '<td>' + this.annotations('prop-annotations') + '</td>' : ''}
+                ${hasDescriptionColumn ? this.description('attribute-description', 'td', true) : ''}
+            </tr>`;
+    }
+}
+exports.default = PropertyMarkupGenerator;
+//# sourceMappingURL=property-markup-generator.js.map

package/lib/apexdoc/engine/generators/models/property-markup-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"property-markup-generator.js","sourceRoot":"","sources":["../../../../../src/apexdoc/engine/generators/models/property-markup-generator.ts"],"names":[],"mappings":";;;AAAA;;IAEI;AACJ,iFAAgD;AAChD,kFAAiD;AAEjD,gFAAgD;AAEhD,MAAM,uBAAwB,SAAQ,0BAA8B;IAClE,YAAsB,KAAoB,EAAE,MAAkC;QAC5E,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,MAAkB,EAAE,MAAkC;QAC3E,MAAM,UAAU,GAAG,kBAAQ,CAAC,MAAM,CAAC,SAAS,KAAK,kBAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC;QAEpH,IAAI,MAAM,GAAG,uBAAuB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAC3D,MAAM,cAAc,GAAG,uBAAuB,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAC5E,MAAM,cAAc,GAAG,uBAAuB,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAE5E,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE;YAC7B,MAAM,SAAS,GAAG,IAAI,uBAAuB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC5D,MAAM,IAAI,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,gBAAgB,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC;SACtF;QAED,MAAM,GAAG,qCAAqC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC;0DACrB,MAAM,CAAC,IAAI;;sBAE/C,MAAM;;mBAET,CAAC;QAEhB,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,MAAM,CAAC,oBAAoB,CAAC,SAAiB;QACrD,OAAO,uBAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACjD,CAAC;IAES,MAAM,CAAC,oBAAoB,CAAC,SAAiB;QACrD,OAAO,uBAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACjD,CAAC;IAES,MAAM,CAAC,SAAS,CAAC,UAAgC;QACzD,IAAI,cAAc,GAAG,EAAE,EACrB,cAAc,GAAG,EAAE,CAAC;QACtB,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACxB,IAAI,CAAC,WAAW,IAAI,CAAC,cAAc,GAAG,sBAAsB,CAAC,CAAC;YAC9D,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,CAAC,cAAc,GAAG,sBAAsB,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QAEH,OAAO;;;;kBAIO,cAAc;kBACd,cAAc;kBACd,CAAC;IACjB,CAAC;IAES,OAAO,CAAC,eAAuB,EAAE,oBAA6B,EAAE,oBAA6B;QACrG,OAAO;kCACuB,IAAI,CAAC,KAAK,CAAC,KAAK;6CACL,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,eAAe,CAAC;;;0BAGvE,yBAAc,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;;;kBAGtD,oBAAoB,CAAC,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE;kBACnF,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;kBACjF,CAAC;IACjB,CAAC;CACF;AAED,kBAAe,uBAAuB,CAAC"}

package/lib/apexdoc/engine/generators/models/source-markup-generator.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) NCR Terafina
+ **/
+import MarkupGenerator from './markup-generator';
+import { TopLevelModel } from '../../../common/models';
+declare class SourceMarkupGenerator extends MarkupGenerator<TopLevelModel> {
+    protected constructor(model: TopLevelModel, models: Map<string, TopLevelModel>);
+    static generate(model: TopLevelModel, models: Map<string, TopLevelModel>): string;
+}
+export default SourceMarkupGenerator;

package/lib/apexdoc/engine/generators/models/source-markup-generator.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/**
+ * Copyright (c) NCR Terafina
+ **/
+const markup_generator_1 = tslib_1.__importDefault(require("./markup-generator"));
+const models_1 = require("../../../common/models");
+class SourceMarkupGenerator extends markup_generator_1.default {
+    constructor(model, models) {
+        super(model, models);
+    }
+    static generate(model, models) {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const generator = new SourceMarkupGenerator(model, models);
+        let markup = '';
+        if (model instanceof models_1.ClassModel) {
+            if (model.isInnerClass) {
+                return '';
+            }
+        }
+        const source = model.source.replace(/</g, '&lt').replace(/>/g, '&gt');
+        if (model.groupName === 'Pages') {
+            markup = `<div class="subsection code">
+            <h3 class="subsection-title code">${model.name} Code</h3>
+            <pre class="code-example"><code class="language-xml">${source}</code></pre>
+            </div>`;
+        }
+        else {
+            markup = `<div class="subsection code">
+            <h3 class="subsection-title code">${model.name} Code</h3>
+            <pre class="code-example"><code class="language-java">${source}</code></pre>
+            </div>`;
+        }
+        return markup;
+    }
+}
+exports.default = SourceMarkupGenerator;
+//# sourceMappingURL=source-markup-generator.js.map

package/lib/apexdoc/engine/generators/models/source-markup-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"source-markup-generator.js","sourceRoot":"","sources":["../../../../../src/apexdoc/engine/generators/models/source-markup-generator.ts"],"names":[],"mappings":";;;AAAA;;IAEI;AACJ,kFAAiD;AACjD,mDAAmE;AAEnE,MAAM,qBAAsB,SAAQ,0BAA8B;IAChE,YAAsB,KAAoB,EAAE,MAAkC;QAC5E,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAoB,EAAE,MAAkC;QAC7E,6DAA6D;QAC7D,MAAM,SAAS,GAAG,IAAI,qBAAqB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAE3D,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,KAAK,YAAY,mBAAU,EAAE;YAC/B,IAAI,KAAK,CAAC,YAAY,EAAE;gBACtB,OAAO,EAAE,CAAC;aACX;SACF;QACD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACtE,IAAI,KAAK,CAAC,SAAS,KAAK,OAAO,EAAE;YAC/B,MAAM,GAAG;gDACiC,KAAK,CAAC,IAAI;mEACS,MAAM;mBACtD,CAAC;SACf;aAAM;YACL,MAAM,GAAG;gDACiC,KAAK,CAAC,IAAI;oEACU,MAAM;mBACvD,CAAC;SACf;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAED,kBAAe,qBAAqB,CAAC"}

package/lib/apexdoc/engine/generators/models/top-level-markup-generator.d.ts

@@ -0,0 +1,10 @@
+import MarkupGenerator from './markup-generator';
+import { TopLevelModel } from '../../../common/models';
+declare class TopLevelMarkupGenerator extends MarkupGenerator<TopLevelModel> {
+    protected constructor(model: TopLevelModel, models: Map<string, TopLevelModel>);
+    static generate(model: TopLevelModel, models: Map<string, TopLevelModel>, additionalContent?: string): string;
+    protected markupTemplate(label: string, contents: string, titleClass?: string, contentClass?: string, tag?: string): string;
+    protected author(): string;
+    protected since(): string;
+}
+export default TopLevelMarkupGenerator;

package/lib/apexdoc/engine/generators/models/top-level-markup-generator.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/**
+ * Copyright (c) NCR Terafina
+ **/
+const generator_utils_1 = tslib_1.__importDefault(require("../generator-utils"));
+const markup_generator_1 = tslib_1.__importDefault(require("./markup-generator"));
+class TopLevelMarkupGenerator extends markup_generator_1.default {
+    constructor(model, models) {
+        super(model, models);
+    }
+    static generate(model, models, additionalContent = '') {
+        const generator = new TopLevelMarkupGenerator(model, models);
+        let markup = '';
+        // add any additional content passed in from the caller. currently, only
+        // use case is the values table used when documenting class-level enums
+        markup += generator.description('class-description');
+        markup += generator.signature('class');
+        markup += additionalContent;
+        markup += generator.deprecated();
+        markup += generator.see();
+        markup += generator.author();
+        markup += generator.since();
+        markup += generator.example();
+        markup = `<div class="class-container">
+                ${markup}
+            </div>`;
+        return markup;
+    }
+    markupTemplate(label, contents, titleClass = '', contentClass = 'class-subtitle-description', tag = 'div') {
+        titleClass = titleClass ? `class-subtitle ${titleClass}` : 'class-subtitle';
+        return super.markupTemplate(label, contents, titleClass, contentClass, tag);
+    }
+    author() {
+        if (!this.model.author) {
+            return '';
+        }
+        return `<br/>${generator_utils_1.default.encodeText(this.model.author, true, this.models)}`;
+    }
+    since() {
+        if (!this.model.since) {
+            return '';
+        }
+        return `<br/>${generator_utils_1.default.encodeText(this.model.since, true, this.models)}`;
+    }
+}
+exports.default = TopLevelMarkupGenerator;
+//# sourceMappingURL=top-level-markup-generator.js.map

package/lib/apexdoc/engine/generators/models/top-level-markup-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"top-level-markup-generator.js","sourceRoot":"","sources":["../../../../../src/apexdoc/engine/generators/models/top-level-markup-generator.ts"],"names":[],"mappings":";;;AAAA;;IAEI;AACJ,iFAAgD;AAChD,kFAAiD;AAGjD,MAAM,uBAAwB,SAAQ,0BAA8B;IAClE,YAAsB,KAAoB,EAAE,MAAkC;QAC5E,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAoB,EAAE,MAAkC,EAAE,iBAAiB,GAAG,EAAE;QACrG,MAAM,SAAS,GAAG,IAAI,uBAAuB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAE7D,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,wEAAwE;QACxE,uEAAuE;QACvE,MAAM,IAAI,SAAS,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;QACrD,MAAM,IAAI,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,IAAI,iBAAiB,CAAC;QAC5B,MAAM,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;QACjC,MAAM,IAAI,SAAS,CAAC,GAAG,EAAE,CAAC;QAC1B,MAAM,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;QAC7B,MAAM,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;QAC5B,MAAM,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,GAAG;kBACK,MAAM;mBACL,CAAC;QAEhB,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,cAAc,CAAC,KAAa,EAAE,QAAgB,EAAE,UAAU,GAAG,EAAE,EAAE,YAAY,GAAG,4BAA4B,EAAE,GAAG,GAAG,KAAK;QACjI,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,kBAAkB,UAAU,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC;QAC5E,OAAO,KAAK,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC;IAC9E,CAAC;IAES,MAAM;QACd,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YACtB,OAAO,EAAE,CAAC;SACX;QAED,OAAO,QAAQ,yBAAc,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;IACnF,CAAC;IAES,KAAK;QACb,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE;YACrB,OAAO,EAAE,CAAC;SACX;QAED,OAAO,QAAQ,yBAAc,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;IAClF,CAAC;CACF;AAED,kBAAe,uBAAuB,CAAC"}

package/lib/apexdoc/engine/generators/see-link-generator.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) NCR Terafina
+ **/
+import * as Models from '../../common/models';
+declare class SeeLinkGenerator {
+    private static isMarkdownURL;
+    private static markdownUrlToLink;
+    static makeLinks(models: Map<string, Models.TopLevelModel>, qualifiers: string[]): string[];
+    /**
+     * Search through methods for a match to the provided qualifier. If a match is made
+     * and an overload selector is provided, continue iterating to see if that overload
+     * exists, and match on it if it does. If it does not, report that no match is made.
+     *
+     * @param methods The methods to search for a match through
+     * @param matcher The user provided qualifier to match against a method name
+     * @param overloadSelector The user provided indicator of the method overload number
+     */
+    private static methodMatcher;
+}
+export default SeeLinkGenerator;