registerTemplate Method

This method is used to register a piece of content that can be included easily using the CTRL+SPACE keys.

Parameters

string: The name of the template
string: A description of the template
function: The function to be called to generate the template, it must return a string

Examples

import {PowerDocsExtension} from "PowerDocs.Lib";

var ext = PowerDocsExtension.create();

function returnCustomTemplate() {

    let mardkDown = "# XXX class\r";
    mardkDown += "The XXX class is used to...\r";
    mardkDown += "\r";
    mardkDown += "## Properties\r";
    mardkDown += "\r";
    mardkDown += "## Methods\r";
    mardkDown += "\r";
    mardkDown += "### Method1()\r";
    mardkDown += "This method is used to...\r";
    mardkDown += "\r";
    mardkDown += "#### Arguments\r";
    mardkDown += "* `type` argument: This argument is used to...";
    mardkDown += "\r";
    mardkDown += "\r";
    mardkDown += "## Events\r";
    return mardkDown;

}

ext.registerTemplate("Class docs", "MS Style C# class documentation", returnCustomTemplate);

Last modified: 08 avril 2024