docfx - ¿Cómo documentar tipos union en TypeScript?
¿Cómo documentar un tipo Union en TypeScript para que typedoc pueda obtener/mostrar información relevante? Esto de abajo es una referencia de JSDoc, pero ¿hay una para TSDoc?
Ejemplo :
/**
* Search parameters
* These comments are not picked up, I generate blank page
*/
export type SearchParams = string | string[][] | Record<string, string>;
/**
* Query parameters
* These comments are not picked up, I generate blank page
*/
export type QueryParams = SearchParams | Record<string, string | string[]>;
Simplemente se recogen por exportación, pero no se generó ninguna información. ([email , [email , [email )
EDITAR: ¿Hay alguna manera de generar documentación para estos tipos usando las herramientas mencionadas arriba?
Respuesta #1
Parece que no importa qué comentarios pongamos allí, DocFx no puede generar páginas para alias de tipo y funciones, sino solo para clases, interfaces, etc... al menos en la versión especificada.
He confirmado esto inspeccionando el archivo de salida *.json generado y los archivos *.yml resultantes. Todos los archivos mencionados incluyen los metadatos, pero docfx no genera las páginas html para ellos de la manera correcta.
Ahora solo estoy usando typedoc con typedoc-plugin-markdown para generar documentación y está funcionando bien en su propia capacidad.