yardoc - online na nuvem

PROGRAMA:

NOME

yardoc - ferramenta Ruby para gerar documentação para a linguagem de programação Ruby

SINOPSE

jarda [opções] [Arquivos Fonte [- arquivos_extras]] quintal doca [opções] [Arquivos Fonte [-
arquivos_extras]]

DESCRIÇÃO

quintal(1) é uma ferramenta extensível de geração de documentação para a linguagem de programação Ruby.
Ele permite que o usuário gere documentação consistente e utilizável que pode ser exportada para um
número de formatos muito facilmente, e também suporta extensão para construções Ruby personalizadas, como
como definições de nível de classe personalizadas.

jardadoc, sinônimo de quintal doca gera a documentação da lista de Arquivos Fonte. Se
esta lista é omitida, "{lib, app} / ** / *. rb ext / ** / *. c" é usado.

Um conjunto básico de opções pode ser especificado adicionando um .yardopts arquivo para o seu caminho base
contendo todas as opções extras separadas por espaços em branco.

OPÇÕES

Geral Opções
-b, --db ARQUIVO
Use um banco de dados .yardoc especificado para carregar ou salvar (o padrão é .yardoc)

--[no-]banco de dados único
Se os objetos de código devem ser armazenados em um único arquivo de banco de dados (avançado)

-n, - sem saída
Gere apenas banco de dados .yardoc, sem documentação.

-c, --use-cache [ARQUIVO]
Use o banco de dados .yardoc em cache para gerar a documentação (o padrão é nenhum cache)

--sem cache
Limpe .yardoc db antes de analisar a fonte.

--[no-]jardas [ARQUIVO]
Se os argumentos devem ser lidos de FILE (o padrão é sim, o padrão de FILE é .yardopts)

--[no-]documento
Se os argumentos devem ser lidos do arquivo .document (o padrão é sim)

--não salvar
Não salve os dados analisados ​​no banco de dados yardoc

--excluir REGEXP
Ignora um arquivo se ele corresponder ao caminho (regexp)

saída opções
--um-file
Gera saída como um único arquivo

--Lista
Listar objetos para padronizar (implica -n)

--não-público
Não mostre métodos públicos. (o padrão mostra público)

--protegido
Mostrar métodos protegidos. (oculta protegida por padrão)

--privado
Mostra métodos privados. (oculta o padrão privado)

--não-privado
Ocultar objetos com a tag @private

- [no-] api API
Gera documentação para uma determinada API (objetos que definem a tag @api correta).
If --no-api é fornecido, exibe objetos sem tag @api.

--embed-mixins
Incorpora métodos mixin na documentação da classe

--embed-mixin [MÓDULO]
Incorpora métodos mixin de um módulo específico na documentação da classe

--no-destaque
Não destaque blocos de código na saída.

--default-return TIPO
Exibido se o método não tiver tipo de retorno. (o padrão é 'Objeto')

--hide-void-return
Oculta os tipos de retorno especificados como 'void'. (o padrão é mostrado)

--consulta INQUERIR
Mostrar apenas objetos que correspondem a uma consulta específica

--título IMERSÃO DE INGLÊS
Adicione um título específico aos documentos HTML

-r, --Leia-me, --a Principal ARQUIVO
O arquivo leia-me usado como página de título da documentação.

--arquivos ARQUIVO 1,ARQUIVO 2, ...
Quaisquer arquivos estáticos extras separados por vírgulas a serem incluídos (por exemplo, FAQ)

--de ativos A PARTIR DE[:TO]
Um arquivo ou diretório para copiar para o diretório de saída após gerar

-o, --diretório de saída PATH
O diretório de saída. (o padrão é ./doc)

-m, --marcação MARK UP
Estilo de marcação usado na documentação, como têxtil, markdown ou rdoc (o padrão é rdoc).

-M MARKUP_PROVIDER
Substitui a biblioteca usada para processar a marcação

--fornecedor de marcação
formatação (especifique o nome da gema)

--charset ENC
Conjunto de caracteres para usar ao analisar arquivos (o padrão é a localidade do sistema)

-t, --modelo MODELO
O modelo a ser usado. (o padrão é "padrão")

-p, --caminho do modelo PATH
O caminho do modelo para procurar modelos. (Usado com -t).

-f, --formato FORMATO
O formato de saída do modelo (o padrão é html).

--sem estatísticas
Não imprima estatísticas

--localidade LOCAL
A localidade para a documentação gerada (o padrão é en).

--po-dir DIR
O diretório que contém arquivos .po (o padrão é # {YARD :: Registry.po_dir}).

etiqueta opções:
(TAG:IMERSÃO DE INGLÊS parece: 'sobrecarga:Sobrecarregado Forma')

--marcação TAG:IMERSÃO DE INGLÊS
Registra um novo metadado de formato livre @tag

--type-tag TAG:IMERSÃO DE INGLÊS
Tag com um campo de tipos opcionais

--type-nome-tag TAG:IMERSÃO DE INGLÊS
Tag com tipos opcionais e um campo de nome

--crachá TAG:IMERSÃO DE INGLÊS
Tag com um campo de nome

--title-tag TAG:IMERSÃO DE INGLÊS
Tag com a primeira linha como campo de título

--hide-tag TAG
Esconde uma tag previamente definida de modelos

--tag transitiva TAG
Marca uma tag como transitiva

--non-transitivo-tag TAG
Marca uma tag como não transitiva

Outros opções:
-e, --carga ARQUIVO
Um script Ruby para carregar antes de executar o comando.

--plugar PLUGAR
Carregar um plugin YARD (gem com prefixo `yard- ')

--legado
Use o analisador e manipuladores de Ruby no estilo antigo. Sempre ativo em 1.8.x.

--seguro
Habilite o modo de segurança para esta instância

-q, --quieto
Não mostre avisos.

--verbose
Mostre mais informações.

--depurar
Mostra informações de depuração.

--backtrace
Mostrar rastreamentos de pilha

-v, --versão
Mostrar versão.

-h, --Socorro
Mostre esta ajuda.

EXEMPLOS

jardadoc -o "documentação /" - "FAQ" "LICENÇA"

O exemplo acima gera documentação para arquivos em "lib / ** / *. Rb" para "documentação /"
incluindo os arquivos extras "FAQ" e "LICENSE".

Use yardoc online usando serviços onworks.net