Pular para o conteúdo principal

Referência viva

Inventário extraído de 551 símbolos: 267 macros, 131 funções C, 117 funções Python e 36 funções Shell. Apelidos curtos/prefixados são reunidos na mesma página de macro.

O que é automático

Nomes, assinaturas, expansões, guards, chamadores, arquivos de teste, linhas, casos dourados e modos fatais vêm do repositório a cada build. Contratos editoriais são complementados por comentários/docstrings; um símbolo novo aparece mesmo antes de ganhar prosa especial.

Use a busca local para procurar qualquer nome, incluindo apelidos. O inventário JSON é a saída determinística para auditoria.

Macros e palavras-chave​

Funções C da biblioteca​

Funções internas​

Veja o inventário interno para transpilador, testes, runners e scripts Python.

Perguntas frequentes​

Perguntas frequentes sobre a referência gerada, suas contagens e seus limites.

O que existe nesta referência?​

551 símbolos inventariados: 267 macros, 131 funções C, 117 funções Python e 36 funções Shell. Macros curtas e prefixadas ficam na mesma página; funções públicas são agrupadas por módulo.

Como procuro um nome ou um apelido?​

Use a busca local do site (atalho de teclado na barra) ou o inventário JSON. A busca indexa também os aliases, que aparecem no título das páginas de macro.

python3 -c "import json; print(json.load(open('website/static/api/inventario.json'))['counts'])"

Por que uma página não tem exemplo de uso?​

Exemplos editoriais vêm de tools/documentacao/contratos.json. Sem contrato, o gerador mostra a expansão, o corpo, os protótipos e os usos reais dos testes; ele não inventa uma chamada que o código não demonstra.

Uma contagem alta aqui significa boa cobertura?​

Não. As contagens são estáticas e incluem menções, não execuções. O total impresso por make test é dinâmico. Compare apenas métricas iguais e leia como ler as evidências.

Como um símbolo novo aparece no site?​

Basta defini-lo em include/, src/, tools/ ou tests/ e rodar o gerador. Não existe lista manual de páginas; o build falha se a saída ficar desatualizada.

python3 tools/gerar_documentacao.py --strict
python3 tools/gerar_documentacao.py --check