[api-documenter] Annotations on type alias parameters are ignored
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Facilidade para iniciantes
- 45/100
- Tipo de issue
- Bug
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- typescript
- Domínio
- documentation
Direção de pesquisa
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.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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 |
- Linguagem predominante
- TypeScript
- Estrelas
- 6.5k
- Forks
- 708
- Merge médio
- 4d 7h
- PRs com merge (30d)
- 61
Preparar o ambiente
Ainda não verificamos os arquivos de configuração deste projeto. Comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de microsoft/rushstack
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
microsoft/rushstack#5971 · 2 comentários ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
microsoft/rushstack#5902 · 1 reação ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
microsoft/rushstack#5839 · 1 reação ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
microsoft/rushstack#5683 · 3 comentários ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 45/100
Mantenedores costumam responder em até 1 dia
Todas as issues de microsoft/rushstack
Issues semelhantes
-
resources
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
railmapgen/rmg-palette#2445 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
danielmiessler/LifeOS#2242 ·
Mantenedores costumam responder em até 5 dias
-
good first issue hacktoberfest help wanted translation
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
callstackincubator/appduct#129 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 88/100