Haddock es un generador de documentación de programa de línea de comandos portátil y gratuito [1] para Haskell . Está influenciado por IDOC , [2] HDoc , [3] y Doxygen . [4] Produce archivos HTML con hipervínculos a partir de archivos fuente anotados de Haskell (la documentación está incrustada en los comentarios ) , con información adicional extraída de las anotaciones de tipo ; solo admite la generación parcial de documentación en SGML . [5] A menudo se usa junto con darcs y Cabal . Es dependiente de Glasgow Haskell Compiler (GHC), usando una forma modificada de la HsParser (escrito en feliz ) analizador para Haskell incluido en GHC. [5] Su marcado ligero se basa en IDOC. [5] El eglefino está contenido en la plataforma Haskell .
Desarrollador (es) | Simon Marlow |
---|---|
Versión inicial | 1 de mayo de 2002 |
Lanzamiento estable | 2.8.0 / 2 de septiembre de 2010 |
Repositorio | |
Escrito en | Haskell |
Sistema operativo | Multiplataforma |
Plataforma | x86 , PowerPC |
Tipo | Generación de documentación |
Licencia | Licencia estilo BSD |
Sitio web | http://haskell.org/haddock/ |
Es utilizado por los proyectos GHC, Gtk2Hs y HTk, [6] así como por XMonad . [ cita requerida ]
Aquí hay un ejemplo de marcado de Haddock:
- | Esta es la documentación para 'cuadrado', que utiliza el operador (*) de "Preludio". - Multiplica el argumento @ x @ contra sí mismo. cuadrado :: Entero -> Entero cuadrado x = x * x
Referencias
- ^ Haddock se ejecuta ensistemas operativos compatibles con POSIX y Microsoft Windows .
- ^ "Manual IDOC - Instalación" . www.cse.unsw.edu.au .
- ^ "Página de inicio de Armin Größlinger" . www.fmi.uni-passau.de .
- ^ "1.3. Colaboradores" . haskell.org .
- ^ a b c "Eglefino: una herramienta de documentación de Haskell" Archivado el 11 de octubre de 2006 en la Wayback Machine - (por Simon Marlow, Actas del taller ACM SIGPLAN sobre Haskell , 2002; PDF )
- ^ "Haddock se está utilizando para documentar las nuevas bibliotecas jerárquicas de Haskell. La documentación generada para las bibliotecas enviadas con la última versión de GHC está aquí. El proyecto Gtk2Hs está usando Haddock para crear documentación de referencia. El proyecto HTk está usando Haddock para generar su documentación de la biblioteca ". Desde la página de inicio de Haddock.
enlaces externos
- Página de inicio de eglefino