Online JSDoc Generator

Propósito e intenção do usuário: a ferramenta gera documentação JSDoc a partir de fontes JavaScript e TypeScript. Ela lê arquivos de origem, extrai declarações documentadas e produz uma referência de API estruturada adequada para autores de bibliotecas, equipes SDK e projetos de código aberto. Suporta tipos TypeScript quando disponíveis, melhorando a precisão das descrições de parâmetros e permitindo uma ligação cruzada entre módulos e símbolos.
Lógica central e recursos: a ferramenta recebe as fontes, extrai blocos JSDoc, resolve símbolos e produz saídas em HTML, Markdown ou JSON. Suporta projetos multi-arquivos, diretórios e entradas de repositório. Opções avançadas incluem templates personalizados, agrupamento de módulos, visibilidade de membros privados, geração incremental, inferência de tipos TypeScript e ganchos de pós-processamento para CI.
Entradas e saídas: entradas incluem source_paths (string ou array, caminhos ou URL de repositório), language (JS/TS), output_format (html, markdown, json), template (nome ou conteúdo), include_private (boolean). Saídas incluem docs_html, docs_markdown, docs_json e um índice de módulos/classes mais um índice pesquisável.
Algoritmos e cálculos: utiliza parsing AST para coletar símbolos e comentários JSDoc, associa comentários às declarações, delimita fronteiras de módulo e aplica templates para produzir documentação estruturada. Validação de sintaxe e tratamento de sintaxe não suportada com placeholders para comentários ausentes.
Erros e casos de borda: gerencia JSDoc ausentes ou incompletos com avisos, lida com grandes bases de código via streaming; fornece padrões para opções não especificadas; avisa sobre falhas de acesso ao repositório ou limites de taxa.
Indústria/Região e Localização: segue convenções comuns de documentação de código em inglês; templates suportam títulos localizados; sem dados de moeda ou região; conforme às convenções de documentação JS/TS.
Suposições e Exclusões: assume que a entrada é código acessível e analisável; exclui documentação de execução ao vivo, dados de runtime ou geração de UI; não é responsável por hospedagem ou renderização além dos formatos de saída escolhidos.