[api-documenter] Annotations on type alias parameters are ignored
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 45/100
- Type d'issue
- Bug
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- typescript
- Domaine
- documentation
Piste de recherche
Start by reproducing the issue in @microsoft/api-documenter with the TypeScript type alias shown in the report and inspect the generated Markdown output. Trace how the alias and its parameter comments are processed. Done means the generated documentation displays the description for bar while preserving the alias description and signature.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Summary
Annotating a type alias as a whole works fine, but individual paramaters are ignored.
Repro steps
Consider the following:
/**
* This is a type alias.
*
* @public
*/
type Foo = {
/**
* This is a parameter.
*/
bar?: unknown;
};
Expected result
For the parameter bar to have its description displayed in the generated markdown file.
Actual result
Generated markdown file:
Foo type
This is a type alias.
Signature:
type Foo = {
bar?: unknown;
};
Standard questions
Please answer these questions to help us investigate your issue more quickly:
| Question | Answer |
|---|---|
@microsoft/api-documenter version? |
7.27.4 |
| Operating system? | Windows |
| Documentation target? | Markdown |
| Would you consider contributing a PR? | Yes |
| TypeScript compiler version? | 5.8.2 |
Node.js version (node -v)? |
24.11.0 |
- Langage dominant
- TypeScript
- Étoiles
- 6.5k
- Forks
- 708
- Merge moyen
- 4 j 7 h
- PR mergées (30 j)
- 61
Préparer son environnement
Nous n'avons pas encore vérifié les fichiers d'installation de ce projet. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de microsoft/rushstack
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
microsoft/rushstack#5971 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
microsoft/rushstack#5902 · 1 réaction ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
microsoft/rushstack#5839 · 1 réaction ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
microsoft/rushstack#5683 · 3 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 4/5 3-5 jours Accessibilité débutants 45/100
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de microsoft/rushstack
Issues similaires
-
Resources: New palettes of MacaoOuverteresources
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
railmapgen/rmg-palette#2445 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
danielmiessler/LifeOS#2242 ·
Les mainteneurs répondent en général sous 5 jours
-
good first issue hacktoberfest help wanted translation
Difficulté 2/5 1-3 heures Accessibilité débutants 84/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
callstackincubator/appduct#129 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 1-3 heures Accessibilité débutants 88/100