rdoc - Online en la nube

PROGRAMA:

NOMBRE

rdoc2.3 - Genera documentación a partir de archivos de secuencia de comandos de Ruby

SINOPSIS

rdoc2.3 [opciones] [nombres ...]

DESCRIPCIÓN

Los archivos se analizan y la información que contienen se recopila antes de que se genere cualquier salida.
producido. Esto permite resolver las referencias cruzadas entre todos los archivos. Si un nombre es un
directorio, se atraviesa. Si no se especifican nombres, todos los archivos Ruby en el actual
se procesan el directorio (y los subdirectorios).

Formateadores de salida disponibles: chm, html, ri, xml

Para obtener información sobre a dónde va la salida, use:
rdoc --ayuda-salida

OPCIONES

--accesor, -A nombre de acceso [, ..]
lista separada por comas de métodos de clase adicionales que deben tratarse como
'attr_reader' y amigos. La opción puede repetirse. Cada nombre de acceso puede tener
'= texto' agregado, en cuyo caso ese texto aparece donde aparece r / w / rw para
accesores normales.

--todos, -a
Incluya todos los métodos (no solo los públicos) en la salida.

- juego de caracteres, -c charset
especifica el conjunto de caracteres HTML

--depurar, -D
muestra un montón de cosas internas

--diagrama, -d
generar diagramas que muestren módulos y clases. Necesita dot V1.8.6 o posterior para usar
la opción --diagram correctamente. Dot está disponible en
<URL:http://www.research.att.com/sw/tools/graphviz/>.

--excluir, -x patrón
no procese archivos o directorios que coincidan con el patrón. Archivos proporcionados explícitamente en el
La línea de comando nunca será excluida.

--extensión, -E new = los ancianos
tratar los archivos que terminan con .new como si terminaran con .old. El uso de '-E cgi = rb'
hacer que xxx.cgi se analice como un archivo Ruby

- cajas de archivos, -F
las clases se colocan en recuadros que representan archivos, donde residen estas clases.
Las clases compartidas entre más de un archivo se muestran con una lista de archivos que se comparten.
ellos. Se descarta silenciosamente si --diagram no se proporciona Experimental.

--fmt, -f nombredeformato
establecer el formateador de salida (ver más abajo).

--ayuda, -h
uso de impresión.

--salida de ayuda, -O
explique las distintas opciones de salida.

--formato de imagen, -I gif | png | jpg | jpeg
establece el formato de imagen de salida para diagramas. Puede ser png, gif, jpeg, jpg. Si esta opcion
se omite, se utiliza png. Requiere --diagram.

--incluir, -i dir [, dir ...]
establecer (o agregar a) la lista de directorios que se buscarán cuando se satisfaga: incluya:
peticiones. Puede usarse más de una vez.

- fuente en línea, -S
muestre el código fuente del método en línea, en lugar de a través de un enlace emergente.

--Línea de números, -N
incluir números de línea en el código fuente

--principal, -m nombre
nombre será la página inicial mostrada.

--unir, -M
al crear la salida ri, fusionar clases procesadas en clases previamente documentadas
del nombre nombre.

--un archivo, -1
poner toda la salida en un solo archivo.

--op, -o dir
establecer el directorio de salida.

--nombreop, -n nombre
establezca el nombre de la salida. No tiene ningún efecto para HTML.

--promiscuo, -p
Al documentar un archivo que contiene un módulo o una clase también definida en otros
archivos, muestra todas las cosas para ese módulo / clase en cada página de archivos. Por defecto, solo
mostrar cosas definidas en ese archivo en particular.

--tranquilo, -q
no muestra el progreso mientras analizamos.

--Rhode Island, -r
generar salida para uso de 'ri'. Los archivos se almacenan en el directorio '.rdoc'
en su directorio de inicio a menos que sea reemplazado por un parámetro --op subsiguiente, por lo que no
se necesitan privilegios especiales.

--ri-sitio, -R
generar salida para uso de 'ri'. Los archivos se almacenan en un directorio de todo el sitio,
haciéndolos accesibles a otros, por lo que se necesitan privilegios especiales.

--ri-sistema, -Y
generar salida para uso de 'ri'. Los archivos se almacenan en un directorio de nivel de sistema,
haciéndolos accesibles a otros, por lo que se necesitan privilegios especiales. Esta opcion es
destinado a ser utilizado durante las instalaciones de Ruby.

- show-hash, -H
un nombre de la forma #nombre en un comentario es un posible hipervínculo a un método de instancia
nombre. Cuando se muestra, el '#' se elimina a menos que se especifique esta opción.

--estilo, -s URL de hoja de estilo
especifica la URL de una hoja de estilo separada.

- ancho de pestaña, -w n
establecer el ancho de los caracteres de tabulación (predeterminado 8).

--plantilla, -T Nombre de la plantilla
establezca la plantilla utilizada al generar la salida.

--título, -t texto
establecer texto como título para la salida.

--versión, -v
mostrar la versión de RDoc.

--webcvs, -W url
especifique una URL para vincular a una interfaz web a CVS. Si la URL contiene un contiene un
'% s', se le agregará el nombre del archivo.

Julio 2014 RDOC2.3(1)

Use rdoc en línea usando los servicios de onworks.net