rdoc - Online na nuvem

PROGRAMA:

NOME

rdoc2.3 - Gerar documentação a partir de arquivos de script Ruby

SINOPSE

rdoc2.3 [opções] [nomes ...]

DESCRIÇÃO

Os arquivos são analisados ​​e as informações que eles contêm coletadas, antes que qualquer saída seja
produzido. Isso permite que referências cruzadas entre todos os arquivos sejam resolvidas. Se um nome é um
diretório, ele é percorrido. Se nenhum nome for especificado, todos os arquivos Ruby no atual
diretório (e subdiretórios) são processados.

Formatadores de saída disponíveis: chm, html, ri, xml

Para obter informações sobre para onde vai a saída, use:
rdoc --help-output

OPÇÕES

--acessador, -A accessorname [, ..]
lista separada por vírgulas de métodos de classe adicionais que devem ser tratados como
'attr_reader' e amigos. A opção pode ser repetida. Cada accessorname pode ter
'= texto' anexado, caso em que esse texto aparece onde r / w / rw aparece para
acessores normais.

--tudo, -a
inclui todos os métodos (não apenas públicos) na saída.

--charset, -c conjunto de caracteres
especifica o conjunto de caracteres HTML

--depurar, -D
exibe muito material interno

--diagrama, -d
gerar diagramas mostrando módulos e classes. Você precisa do ponto V1.8.6 ou posterior para usar
a opção --diagram corretamente. Dot está disponível em
<URL:http://www.research.att.com/sw/tools/graphviz/>.

--excluir, -x de cinto de segurança
não processe arquivos ou diretórios que correspondam ao padrão. Arquivos fornecidos explicitamente no
linha de comando nunca será excluída.

--extensão, -E novo = velho
trate os arquivos que terminam com .new como se terminassem com .old. Usar '-E cgi = rb' irá
fazer com que xxx.cgi seja analisado como um arquivo Ruby

--caixas de arquivos, -F
as classes são colocadas em caixas que representam arquivos, onde essas classes residem.
As aulas compartilhadas entre mais de um arquivo são mostradas com a lista de arquivos que compartilham
eles. Descartado silenciosamente se --diagram não for fornecido Experimental.

--fmt, -f nome do formato
definir o formatador de saída (veja abaixo).

--ajuda, -h
uso de impressão.

--saída de ajuda, -O
explicar as várias opções de saída.

--Formato de imagem, -I gif | png | jpg | jpeg
define o formato da imagem de saída para diagramas. Pode ser png, gif, jpeg, jpg. Se esta opção
é omitido, png é usado. Requer --diagram.

--incluir, -i dir [, dir ...]
definir (ou adicionar) a lista de diretórios a serem pesquisados ​​ao satisfazer: incluir:
solicitações de. Pode ser usado mais de uma vez.

--fonte inline, -S
mostre o código-fonte do método embutido, em vez de por meio de um link pop-up.

--números de linha, -N
incluir números de linha no código-fonte

--a Principal, -m nome
nome será a página inicial exibida.

--mesclar, -M
ao criar a saída ri, mescle as classes processadas em classes documentadas anteriormente
do nome nome.

- um arquivo, -1
coloque toda a saída em um único arquivo.

--op, -o dir
definir o diretório de saída.

--opnome, -n nome
defina o nome da saída. Não tem efeito para HTML.

--promíscuo, -p
Ao documentar um arquivo que contém um módulo ou classe também definida em outro
arquivos, mostra todo o material para aquele módulo / classe em cada página de arquivos. Por padrão, apenas
mostrar coisas definidas naquele arquivo específico.

--quieto, -q
não mostra progresso enquanto analisamos.

--ri, -r
gerar saída para uso por 'ri.' Os arquivos são armazenados no diretório '.rdoc'
em seu diretório inicial, a menos que seja substituído por um parâmetro --op subsequente, portanto, não
privilégios especiais são necessários.

--ri-site, -R
gerar saída para uso por 'ri.' Os arquivos são armazenados em um diretório de todo o site,
tornando-os acessíveis a outras pessoas, portanto, privilégios especiais são necessários.

--ri-sistema, -Y
gerar saída para uso por 'ri.' Os arquivos são armazenados em um diretório de nível de sistema,
tornando-os acessíveis a outras pessoas, portanto, privilégios especiais são necessários. Esta opção é
destinado a ser usado durante as instalações do Ruby.

--show-hash, -H
um nome do formulário #nome em um comentário é um possível hiperlink para um método de instância
nome. Quando exibido, o '#' é removido, a menos que esta opção seja especificada.

--estilo, -s URL da folha de estilo
especifica o URL de uma folha de estilo separada.

--largura da guia, -w n
definir a largura dos caracteres da tabulação (padrão 8).

--modelo, -T nome do modelo
definir o modelo usado ao gerar saída.

--título, -t texto
defina o texto como o título da saída.

--versão, -v
exibir a versão do RDoc.

--webcvs, -W url
especifique uma URL para vincular a um frontend da web para o CVS. Se o URL contém um, contém um
'% s', o nome do arquivo será anexado a ele.

Julho de 2014 RDOC2.3(1)

Use rdoc online usando serviços onworks.net