Function assertConstructorDocs

_tools/check_docs.ts:328–344

* Checks a constructor document for: * - No TypeScript parameters marked with `public`, `protected`, or `private`. * - A code https://jsdoc.app/tags-param | @param tag for each parameter. * - At least one code https://jsdoc.app/tags-example | @example tag with * a code snippet th

(
  constructor: DocNodeWithJsDoc<ClassConstructorDef>,
)

 *   a code snippet that executes successfully.
 */
function assertConstructorDocs(
  constructor: DocNodeWithJsDoc<ClassConstructorDef>,
) {
  for (const param of constructor.params) {
    assert(
      param.accessibility === undefined,
      "Do not use `public`, `protected`, or `private` parameters in constructors",
      constructor,
    );
    if (param.kind === "identifier") {
      assertHasParamTag(constructor, param.name);
    }
    if (param.kind === "assign" && param.left.kind === "identifier") {
      assertHasParamTag(constructor, param.left.name);
    }
  }
}

/**
 * Checks a module document for: