RDoc

RDoc é feito de duas partes principais.

Um é rdoc , um utilitário para gerar documentação HTML. A segunda é ri , uma ferramenta para criação de documentação para a interface de linha de comando Ruby.

Para ser capaz de usar adequadamente RDoc, o desenvolvedor deve mudar a maneira como ele adiciona comentários a seu código-fonte.

RDoc usa uma estrutura de comentários de código fonte específica, para que eles possam ser facilmente extraído e ajudar a preencher o site de documentação.

estrutura comentário de RDoc é extremamente bem sucedido, sendo usada por muitos geradores de documentação semelhantes criados para outras linguagens de programação

O que é novo nesta versão:.

• RDoc pode produzir arquivos de tradução para uso com gettext.

O que é novo na versão 4.2.0:

• RDoc pode produzir arquivos de tradução para uso com gettext .

O que é novo na versão 4.1.0:.

• Melhoria da acessibilidade de saída HTML
• O olhar de RDoc foi atualizado.

O que é novo na versão 4.0.0:.

• Adicionado Markdown como um formato suportado
• ri pode agora mostrar páginas (README, etc.).
• estado global removido do RDoc. RDoc :: loja mantém a árvore de documentação e se conecta ao motorista para os analisadores e gerador.

O que é novo na versão 3.12:

• Pequenas melhorias:
• documento Adicionado COLABORADORES, que contém uma visão geral de como funciona RDoc e como adicionar novos recursos para RDoc.
• Melhoria título para a saída HTML para incluir --title no elemento título.
• rdoc --pipe agora entende --markup.
• RDoc agora suporta irc-esquema de hiperlinks.
• Correções de bugs:
• título fixo na saída HTML para as páginas.
• parsing fixo de heredoc não-recuado.
• parsing fixo de% w [] e outros literais%.
• substituição seta fixo na saída HTML munging o operador nave espacial.
• seções Verbatim com ERB que correspondem ao whitelist código Ruby não são mais sintaxe-destacado.
• Os fins de linha nas janelas são normalizados imediatamente após a leitura com binmode.
• RDoc entende melhor diretrizes para comentários. directivas comentário agora pode ser encontrado em qualquer lugar nos comentários multi-linha.
• ligações arrumada para métodos de mostrar o rótulo novamente.
• RDoc :: Parser :: C podem agora encontrar diretamente acima rb_define_class_under.
• Em rdoc, retrocesso e formatadores ansi, rótulos e notas sem corpos são agora mostrados.
• Em rdoc, retrocesso e formatadores ansi, espaço em branco entre etiqueta ou nota e do cólon é agora despojado.

O que é novo na versão 3.11:

• Correções de bugs:
• Evite analisar arquivos tags incluídas em jóias.

O que é novo na versão 3.9.2:

• correção de bug:
• afrouxou TIDYLINK regexp para permitir qualquer conteúdo na seção link como: & # X3C; tt & # x3e; {foo} [rdoc-ref: SomeClass] & # X3C; / tt & # x3e;
• Nas posições de saída HTML são limitadas em & # X3C; tt & # x3e; & # X3C; h6 & # x3e; & # X3C; / tt & # x3e; novamente.

O que é novo na versão 3.9.1:

• Correções de bugs:
• RDoc Fix :: analisador de marcação para um cabeçalho seguido por um símbolo não-texto.
• Fix RDoc :: :: Markup ToHtmlCrossref # gen_url para não - & # X3C; tt & # x3e; rdoc-ref & # X3C; / tt & # x3e; links.
• Fix relatório de erro URL quando rdoc falhas.

O que é novo na versão 3.8:

• Pequenas melhorias:
• RDoc :: Parser :: C podem agora descobrir métodos na ENV e argF.
• RDoc :: Parser :: C agora sabe sobre rb_cSocket e rb_mDL.
• Correções de bugs:
• Atualização objeto em um armazenamento de dados ri com novos dados agora remove métodos, inclui, constantes e aliases.

O que é novo na versão 3.7:

• Pequenas melhorias:
• Nova directiva: categoria: o que permite que os métodos a serem agrupados em seções mais limpa. Veja RDoc :: Markup para mais detalhes.
• Document classe para RDoc :: Parser :: C agora suporta Foo :: CONST, bem como CONST.
• saída do método ri agora é uma lista separada por vírgulas quando exibido de forma interativa.
• RDoc :: ClassModule # mesclar agora prefere informações do argumento sobre o receptor (que agora se comporta como Hash # merge! Em vez de um Hash # merge para trás!).
• RDoc :: marcação # converter agora aceita um RDoc :: :: Markup instância documento
• RDoc agora possui o código para gerar RDoc e os dados ri quando instalar gems
• Adicionado RDoc :: :: RDoc redefinir
• RDoc Adicionado :: CodeObject # file_name
• Correções de bugs:
• RI não falha ao tentar completar uma planície
• RDoc :: Parser :: Rubi não come conteúdo quando = começam blocos / = documentação final são seguidos por um item de documentable. Edição # 41 por MFN.
• RDoc :: :: Markup Formatter e subclasses agora permitir que um + marcação opcional + parâmetro para a adição de marcação personalizada. O exemplo na RDoc :: :: Markup Formatter agora irá funcionar.
• RDoc :: Parser :: C agora pode distinguir entre métodos de classe e métodos de instância no documento-método.
• RDoc agora codifica nomes de arquivos na codificação de saída.
• geração de dados ri para aliases método não duplica a classe em #full_name