Este es el comando haddock que se puede ejecutar en el proveedor de alojamiento gratuito de OnWorks utilizando una de nuestras múltiples estaciones de trabajo en línea gratuitas, como Ubuntu Online, Fedora Online, emulador en línea de Windows o emulador en línea de MAC OS.
PROGRAMA:
NOMBRE
eglefino - herramienta de documentación para el código fuente anotado de Haskell
SINOPSIS
eglefino [opciones] presentar...
DESCRIPCIÓN
Esta página de manual documenta brevemente la eglefino mando. La documentación extensa es
disponible en varios otros formatos, incluidos DVI, PostScript y HTML; vea abajo.
presentar es un nombre de archivo que contiene un módulo fuente de Haskell. Todos los módulos especificados en el
La línea de comando se procesará en conjunto. Cuando un módulo se refiere a una entidad en otro
módulo que se está procesando, la documentación se vinculará directamente a esa entidad.
Entidades que no se pueden encontrar, por ejemplo porque están en un módulo que no se está
procesado como parte del lote actual, simplemente no será hipervinculado en el generado
documentación. eglefino Emitirá advertencias enumerando todos los identificadores que no pudo
resolver.
Los módulos no deben ser recursivos entre sí, ya que eglefino no le gusta nadar en
círculos
CAMPUS
Los programas siguen la sintaxis habitual de la línea de comandos GNU, con opciones largas que comienzan con dos
guiones (`- '). Un resumen de las opciones se incluye a continuación. Para obtener una descripción completa, consulte
la otra documentación.
-o DIR, --odir =DIR
directorio en el que poner los archivos de salida
-i ARCHIVO, --read-interface =ARCHIVO
leer una interfaz de ARCHIVO.
-D ARCHIVO, --dump-interface =ARCHIVO
volcar una interfaz para estos módulos en ARCHIVO.
-l DIR, --lib =DIR
ubicación de los archivos auxiliares de Haddock
-h, --html
Genera documentación en formato HTML. Se generarán varios archivos en el
directorio actual (o el directorio especificado si el -o se da la opción), incluyendo
el seguimiento:
index.html
La página de nivel superior de la documentación: enumera los módulos disponibles, utilizando
sangría para representar la jerarquía si los módulos son jerárquicos.
eglefino.css
La hoja de estilo utilizada por el HTML generado. Siéntase libre de modificar esto para
cambiar los colores o el diseño, o incluso especificar su propia hoja de estilo utilizando el
--css .
módulo.html
Una página HTML para cada módulo.
doc-index.html, doc-indice-XX.html
El índice, dividido en dos (funciones / constructores y tipos / clases, según
Espacios de nombres Haskell) y dividirlos alfabéticamente.
--hoogle
salida para Hoogle
--html-help =formato
producir índice y tabla de contenido en formato mshelp, mshelp2 o devhelp (con -h)
--source-base =Enlance
Incluya enlaces a los archivos de origen en la documentación generada, donde URL es el
URL base donde se pueden encontrar los archivos de origen.
-s URL, --source-module =Enlance
Incluya enlaces a los archivos de origen en la documentación generada, donde URL es un
enlace de código fuente para cada módulo (usando las variables% {FILE} o% {MODULE}).
- entidad-fuente =Enlance
Incluya enlaces a los archivos de origen en la documentación generada, donde URL es un
enlace de código fuente para cada entidad (usando las variables% {FILE},% {MODULE} o% {NAME}).
--comentarios-base =Enlance
URL para un enlace de comentarios sobre el contenido y las páginas de índice.
--comentarios-módulo =Enlance
URL para un enlace de comentarios para cada módulo (usando% {MODULE} var).
--comments-entity =Enlance
URL para un enlace de comentarios para cada entidad (usando% {FILE},% {MODULE} o% {NAME}
variables).
--css =ARCHIVO
Usa el CSS ARCHIVO en lugar de la hoja de estilo predeterminada que viene con eglefino para HTML
producción. Debe especificar ciertas clases: consulte la hoja de estilo predeterminada para obtener más detalles.
-p ARCHIVO, --prólogo =ARCHIVO
Especifique un archivo que contenga texto de prólogo.
-t TÍTULO, --title =TÍTULO
Uso TÍTULO como el encabezado de cada página de la documentación. Esta voluntad
normalmente será el nombre de la biblioteca que se está documentando.
El título debe ser una cadena simple (¡sin marcas, por favor!).
-k NOMBRE, --paquete =NOMBRE
Especifique el nombre del paquete (opcional).
-n, --no-implícito-preludio
no asuma que Prelude es importado
-d, --depurar
Habilite la salida de depuración adicional.
-?, --ayuda
Mostrar ayuda.
-V, --versión
Versión de visualización.
-v, --verboso
Informes de estado detallados.
--use-contents =Enlance
Utilice una página de contenido HTML generada por separado.
- contenido genético
Genere un contenido HTML a partir de interfaces especificadas.
--use-index =Enlance
Utilice un índice HTML generado por separado.
- índice genético
Genere un índice HTML a partir de interfaces especificadas.
- ignorar-todas-las-exportaciones
Comportarse como si todos los módulos tuvieran el atributo ignorar-exportar
--hide =MÓDULO
Compórtate como si MÓDULO tiene el atributo hide.
--use-package =PAQUETE
Los módulos que se procesan dependen de PAQUETE.
Use eglefino en línea usando los servicios de onworks.net
