export function extractDocs()

in src/docgen/schema.ts [480:498]


export function extractDocs(docs: reflect.Docs): DocsSchema {
  const links = [];
  const see = docs.docs.see; // @see
  if (see && see.length > 0) {
    links.push(see);
  }
  const link = docs.customTag('link'); // @link
  if (link && link.length > 0) {
    links.push(link);
  }
  return filterUndefined({
    // ignore defaults and empty strings to save space
    summary: docs.summary.length > 0 ? docs.summary : undefined,
    remarks: docs.remarks.length > 0 ? docs.remarks : undefined,
    links: links.length > 0 ? links : undefined,
    deprecated: docs.deprecated === true ? true : undefined,
    deprecationReason: docs.deprecationReason,
  });
}