yardoc - Online en la nube

PROGRAMA:

NOMBRE

yardoc: herramienta Ruby para generar documentación para el lenguaje de programación Ruby

SINOPSIS

jardinero [opciones] [archivos fuente [- archivos_extra]] patio doc [opciones] [archivos fuente [-
archivos_extra]]

DESCRIPCIÓN

patio(1) es una herramienta de generación de documentación extensible para el lenguaje de programación Ruby.
Permite al usuario generar documentación coherente y utilizable que se puede exportar a un
varios formatos muy fácilmente, y también admite la ampliación de construcciones personalizadas de Ruby como
como definiciones de nivel de clase personalizadas.

yardoc, sinónimo de patio doc genera la documentación de la lista de archivos fuente. Si
esta lista se omite, se usa "{lib, app} / ** / *. rb ext / ** / *. c".

Se puede especificar un conjunto básico de opciones agregando un .yardopts archivo a su ruta base
que contiene todas las opciones adicionales separadas por espacios en blanco.

OPCIONES

General
-b, --db ARCHIVO
Utilice una base de datos .yardoc especificada para cargar o guardar en (el valor predeterminado es .yardoc)

--[nO-]db único
Si los objetos de código deben almacenarse en un solo archivo de base de datos (avanzado)

-n, --ninguna salida
Genere solo la base de datos .yardoc, sin documentación.

-c, --use-caché [ARCHIVO]
Utilice la base de datos .yardoc en caché para generar documentación (por defecto, sin caché)

--sin caché
Borre .yardoc db antes de analizar la fuente.

--[nO-]patios [ARCHIVO]
Si los argumentos deben leerse desde ARCHIVO (por defecto es sí, ARCHIVO por defecto es .yardopts)

--[nO-]documento
Si los argumentos deben leerse del archivo .document (el valor predeterminado es sí)

--no guardar
No guarde los datos analizados en la base de datos yardoc

--excluir REGEXP
Ignora un archivo si coincide con la ruta de acceso (regexp)

Salida opciones
--un archivo
Genera salida como un solo archivo

--lista
Listar objetos a salida estándar (implica -n)

--no público
No muestre métodos públicos. (el valor predeterminado muestra público)

--protegido
Mostrar métodos protegidos. (por defecto se esconde protegido)

--privado
Mostrar métodos privados. (por defecto oculta privado)

--no-privado
Ocultar objetos con la etiqueta @private

- [no-] api API
Genera documentación para una API determinada (objetos que definen la etiqueta @api correcta).
If --no-api se proporciona, muestra objetos sin etiqueta @api.

--embed-mixins
Incorpora métodos mixin en la documentación de la clase

--embed-mixin [MÓDULO]
Incorpora métodos mixin de un módulo en particular en la documentación de la clase

--no resaltar
No resalte bloques de código en la salida.

--retorno predeterminado TIPO
Se muestra si el método no tiene tipo de retorno. (predeterminado en 'Objeto')

--ocultar-vacío-retorno
Oculta los tipos de devolución especificados como 'void'. (se muestra por defecto)

--consulta CONSULTA
Mostrar solo objetos que coincidan con una consulta específica

--título TÍTULO
Agregar un título específico a los documentos HTML

-r, --léeme, --principal ARCHIVO
El archivo Léame utilizado como página de título de la documentación.

--archivos FILE1,FILE2, ...
Cualquier archivo estático adicional separado por comas que se incluirá (p. Ej., Preguntas frecuentes)

--activo DESDE[:A]
Un archivo o directorio para copiar al directorio de salida después de generar

-o, --salida-dir TRAYECTORIA
El directorio de salida. (predeterminado en ./doc)

-m, --margen MARGEN
Estilo de marcado utilizado en la documentación, como textil, markdown o rdoc (por defecto es rdoc).

-M MARKUP_PROVIDER
Anula la biblioteca utilizada para procesar el marcado

--proveedor de marcas
formato (especifique el nombre de la gema)

--juego de caracteres ENC
Juego de caracteres para usar al analizar archivos (el valor predeterminado es la configuración regional del sistema)

-t, --plantilla PLANTILLA
La plantilla a utilizar. (predeterminado en "predeterminado")

-p, --plantilla-ruta TRAYECTORIA
La ruta de la plantilla en la que buscar plantillas (se usa con -t).

-f, --formato FORMATO
El formato de salida de la plantilla (predeterminado en html).

--no-estadísticas
No imprima estadísticas

--lugar LOCAL
La configuración regional para la documentación generada (por defecto es en).

--po-dir DIR
El directorio que tiene archivos .po (predeterminado en # {YARD :: Registry.po_dir}).

Etiqueta opciones:
(ETIQUETA:TÍTULO parece: 'sobrecarga:Sobrecargado Método')

--etiqueta ETIQUETA:TÍTULO
Registra un nuevo @tag de metadatos de formato libre

--tipo-etiqueta ETIQUETA:TÍTULO
Etiqueta con un campo de tipos opcional

--tipo-nombre-etiqueta ETIQUETA:TÍTULO
Etiqueta con tipos opcionales y un campo de nombre

- etiqueta de nombre ETIQUETA:TÍTULO
Etiqueta con un campo de nombre

--etiqueta de título ETIQUETA:TÍTULO
Etiqueta con la primera línea como campo de título

--ocultar-etiqueta ETIQUETA
Oculta una etiqueta previamente definida de las plantillas

--etiqueta-transitiva ETIQUETA
Marca una etiqueta como transitiva

- etiqueta no transitiva ETIQUETA
Marca una etiqueta como no transitiva

Otros opciones:
-e, --carga ARCHIVO
Un script de Ruby para cargar antes de ejecutar el comando.

--enchufar ENCHUFAR
Cargue un complemento YARD (gema con el prefijo 'yard-')

--legado
Utilice analizadores y manejadores Ruby de estilo antiguo. Siempre encendido en 1.8.x.

--a salvo
Habilita el modo seguro para esta instancia

-q, --tranquilo
No muestre advertencias.

--verboso
Muestre más información.

--depurar
Muestra información de depuración.

--retroceso
Mostrar seguimientos de pila

-v, --versión
Mostrar versión.

-h, --ayuda
Muestre esta ayuda.

EJEMPLOS

yardoc -o "documentación /" - "Preguntas frecuentes" "LICENCIA"

El ejemplo anterior genera documentación para archivos en "lib / ** / *. Rb" a "documentación /"
incluidos los archivos adicionales "Preguntas frecuentes" y "LICENCIA".

Utilice yardoc en línea utilizando los servicios de onworks.net