Function assertClassDocs

_tools/check_docs.ts:269–308

* Asserts that a class document has: * - A `@typeParam` tag for each type parameter. * - At least one code https://jsdoc.app/tags-example | @example tag with * a code snippet that executes successfully. * - Documentation on all properties, methods, and constructors.

(document: DocNodeWithJsDoc<DocNodeClass>)

 * - Documentation on all properties, methods, and constructors.
 */
function assertClassDocs(document: DocNodeWithJsDoc<DocNodeClass>) {
  for (const typeParam of document.classDef.typeParams) {
    assertHasTypeParamTags(document, typeParam.name);
  }
  if (!document.jsDoc.tags?.some((tag) => tag.kind === "example")) {
    assertHasExampleTag(document);
  }

  for (const property of document.classDef.properties) {
    if (property.jsDoc === undefined) continue; // this is caught by `deno doc --lint`
    assert(
      property.accessibility === undefined,
      "Do not use `public`, `protected`, or `private` fields in classes",
      property,
    );
    assertClassPropertyDocs(
      property as DocNodeWithJsDoc<ClassPropertyDef>,
    );
  }
  for (const method of document.classDef.methods) {
    if (method.jsDoc === undefined) continue; // this is caught by `deno doc --lint`
    assert(
      method.accessibility === undefined,
      "Do not use `public`, `protected`, or `private` methods in classes",
      document,
    );
    assertFunctionDocs(method as DocNodeWithJsDoc<ClassMethodDef>);
  }
  for (const constructor of document.classDef.constructors) {
    if (constructor.jsDoc === undefined) continue; // this is caught by `deno doc --lint`
    assert(
      constructor.accessibility === undefined,
      "Do not use `public`, `protected`, or `private` constructors in classes",
      constructor,
    );
    assertConstructorDocs(
      constructor as DocNodeWithJsDoc<ClassConstructorDef>,
    );
  }
}

/**
 * Asserts that a class property document has: