RDoc

RDoc se compone de dos partes principales.

Uno de ellos es rdoc , una utilidad para generar documentación HTML. La segunda es ri , una herramienta para la creación de documentación para la interfaz de línea de comandos de Ruby.

Para poder utilizar adecuadamente RDoc, el desarrollador debe cambiar la forma en que agrega comentarios a su código fuente.

RDoc utiliza una estructura de comentarios de código fuente específica, por lo que se puede extraer fácilmente y ayudar a poblar el sitio de la documentación.

estructura comentario de RDoc es un gran éxito, siendo utilizado por muchos generadores de documentación similares creados por otros lenguajes de programación

¿Qué hay de nuevo en esta versión:.

• RDoc ahora pueden producir archivos de traducción para su uso con gettext.

¿Qué hay de nuevo en la versión 4.2.0:

• RDoc ahora pueden producir archivos de traducción para su uso con gettext .

¿Qué hay de nuevo en la versión 4.1.0:.

• Mejora de la accesibilidad de salida HTML
• El aspecto de RDoc se ha actualizado.

¿Qué es la nueva en la versión 4.0.0:.

• Agregado de rebajas como un formato compatible
• ri ahora puede mostrar páginas (README, etc.).
• estado global Fuera del RDoc. RDoc :: Tienda sostiene el árbol de documentación y conecta el conductor con los analizadores y generadores.

¿Qué hay de nuevo en la versión 3.12:

• Mejoras menores:
• documento Agregado DESARROLLADORES que contiene una visión general de cómo funciona la rdoc y cómo añadir nuevas características a RDoc.
• Mejora de título para la salida HTML para incluir --title en el elemento de título.
• --pipe rdoc ahora entiende --markup.
• RDoc ahora es compatible con hipervínculos IRC-esquema.
• Corrección de errores:
• Título fijo en la salida HTML de las páginas.
• análisis fijo de heredoc no sangrado.
• análisis fijo de% w [] y otros literales%.
• reemplazo flecha fija en la salida HTML munging el operador de la nave espacial.
• secciones Verbatim con ERB que coinciden con la lista blanca de código Ruby ya no son sintaxis resaltado.
• Los finales de línea en las ventanas se normalizan inmediatamente después de la lectura con binmode.
• RDoc entiende mejor directivas para comentarios. directivas de comentarios se pueden encontrar en cualquier parte de los comentarios de varias líneas.
• Tidy enlaces a métodos muestran la etiqueta de nuevo.
• RDoc :: Parser :: C puede ahora encontrar comentarios directamente sobre rb_define_class_under.
• En rdoc, retroceder y formateadores ANSI, etiquetas y notas sin cuerpos se muestran ahora.
• En rdoc, retroceder y formateadores ANSI, espacio en blanco entre la etiqueta o una nota y el colon lo han despojado.

¿Qué hay de nuevo en la versión 3.11:

• Corrección de errores:
• Evite analizar archivos TAGS incluidos en gemas.

¿Qué hay de nuevo en la versión 3.9.2:

• Corrección de error:
• Aflojado TIDYLINK expresión regular para permitir que cualquier contenido en el tramo de enlace como: & # x3c; tt & # X3e; {foo} [rdoc-ref: SomeClass] & # x3c; / tt & # X3e;
• En las partidas de salida HTML tienen un límite de x3c & #; & # tt X3e; & # x3c; h6 & # X3e; & # x3c; / tt & # X3e; de nuevo.

¿Qué hay de nuevo en la versión 3.9.1:

• Corrección de errores:
• RDoc Fix :: analizador de marcado para una cabecera seguida de un contador no es de texto.
• Fix RDoc :: :: marcado ToHtmlCrossref # gen_url para la no - & # x3c; tt & # X3e; rdoc-ref & # x3c; / tt & # X3e; enlaces.
• Fix informe de error URL cuando se bloquea rdoc.

¿Qué hay de nuevo en la versión 3.8:

• Mejoras menores:
• RDoc :: Parser :: C ahora puede descubrir métodos en ENV y ARGF.
• RDoc :: Parser :: C conozca ahora rb_cSocket y rb_mDL.
• Corrección de errores:
• Actualización de objetos en un almacén de datos con nuevos datos ri ahora elimina métodos, incluye, constantes y alias.

¿Qué hay de nuevo en la versión 3.7:

• Mejoras menores:
• Nueva directiva: Categoría: que permite a los métodos que se agrupan en secciones más limpia. Ver RDoc :: marcado para más detalles.
• clase de documentos para RDoc :: Parser :: C ahora es compatible con Foo :: CONST, así como CONST.
• Método de salida ri es ahora una lista separada por comas cuando se muestra de forma interactiva.
• RDoc :: ClassModule # fusionan ahora prefiere la información de la discusión sobre el receptor (que ahora se comporta como Hash # sincronización! En lugar de un hash # fusionar al revés!).
• RDoc :: Marcado # convierten ahora acepta un RDoc :: :: marcado de instancia de documento
• RDoc ahora posee el código para generar RDoc y datos ri cuando se instalan las gemas
• Añadido RDoc :: :: RDoc restablecer
• Añadido RDoc :: CodeObject # nombre_archivo
• Corrección de errores:
• ri ya no se bloquea al intentar completar una llanura
• RDoc :: Parser :: Rubí ya no se come el contenido cuando comienzan los bloques = / = documentación final vienen seguidas de un elemento documentable. La edición # 41 por MFN.
• RDoc :: :: marcado formateador y subclases ahora permiten un margen de beneficio opcional + + parámetro para añadir marcado personalizado. En el ejemplo de marcado de RDoc :: :: formateador ahora funcionará.
• RDoc :: Parser :: C ahora puede distinguir entre los métodos de clase y los métodos de instancia en el Documento-método.
• RDoc codifica ahora los nombres de archivo en la codificación de salida.
• ri generación de los datos para los alias método ya no duplica la clase en #full_name