Comment documenter les types d'union dans le script ?

Question

Comment documenter le type d'Union dans le script de façon typedoc peut tirer/afficher des informations pertinentes ? Ce qui suit est une référence JSDoc, mais en existe-t-il une pour TSDoc ?

Exemple

/**
 * 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[]>;

Ils sont juste ramassés à cause de l'exportation mais aucune information n'a été générée. ( docfx@2.56.6 , typedoc@0.19.2 , type2docfx@0.10.5 )

EDIT : Existe-t-il un moyen de générer des documents pour ces types de documents à l'aide des outils ci-dessus ?

Answer 1

Il semble que peu importe les commentaires que nous y mettons, DocFx est incapable de générer des pages pour les alias de type et les fonctions mais seulement pour les classes, les interfaces, etc... au moins dans la version spécifiée.

Je l'ai confirmé en inspectant les données générées *.json et le fichier de sortie résultant *.yml des dossiers. Tous les fichiers mentionnés incluent les métadonnées mais le docfx ne génère pas les pages html pour eux de la bonne manière.

Maintenant, j'utilise seulement typedoc avec typedoc-plugin-markdown pour générer des documents et cela fonctionne très bien en tant que tel.