From e6bb1149f7e46d9129b9854a81b23122093c43ec Mon Sep 17 00:00:00 2001 From: dons Date: Sun, 16 May 2004 03:21:34 +0000 Subject: [PATCH] Import idoc-0.2.6, a minimalist documentation tool for Haskell "IDoc extracts interface documentation and declarations from Haskell modules based on standard Haskell layout rules and a small number of clues that the programmer embeds in interface comments. These clues have been designed to be visually non-imposing when displaying the source in a text editor. Interface documentation is rendered in standard markup languages (currently, only HTML is supported). IDoc has been designed to be simple to use and install." IDoc has an advantage over other interface doc tools (like haddock) in that it is pure Haskell98, and builds with both ghc and nhc98, making it far more portable. ok pvalchev@ --- devel/idoc/Makefile | 37 +++++++++++++++++++++++++++++++++++++ devel/idoc/distinfo | 3 +++ devel/idoc/pkg/DESCR | 7 +++++++ devel/idoc/pkg/PLIST | 4 ++++ 4 files changed, 51 insertions(+) create mode 100644 devel/idoc/Makefile create mode 100644 devel/idoc/distinfo create mode 100644 devel/idoc/pkg/DESCR create mode 100644 devel/idoc/pkg/PLIST diff --git a/devel/idoc/Makefile b/devel/idoc/Makefile new file mode 100644 index 00000000000..e6ca69d2504 --- /dev/null +++ b/devel/idoc/Makefile @@ -0,0 +1,37 @@ +# $OpenBSD: Makefile,v 1.1.1.1 2004/05/16 03:21:34 dons Exp $ + +COMMENT= "minimalist documentation tool for Haskell" + +V= 0.2.6 +DISTNAME= idoc-${V} +CATEGORIES= devel +MAINTAINER= Don Stewart +HOMEPAGE= http://www.cse.unsw.edu.au/~chak/haskell/idoc/ +MASTER_SITES= ${HOMEPAGE} + +# pure Haskell 98 +.if ${MACHINE} == "i386" || ${MACHINE} == "sparc" || ${MACHINE} == "amd64" +MODULES= ghc +.else +BUILD_DEPENDS+= bin/nhc98::lang/nhc98 +MAKE_FLAGS= HC=nhc98 +.endif + +ALL_TARGET= +USE_GMAKE= Yes + +do-install: + ${INSTALL_PROGRAM} ${WRKSRC}/idoc ${PREFIX}/bin + ${INSTALL_DATA_DIR} ${PREFIX}/share/doc/idoc + ${INSTALL_DATA} ${WRKSRC}/README ${PREFIX}/share/doc/idoc/ + +do-regress: + (cd ${WRKSRC}/test && ../idoc Foo.hs && /usr/bin/lynx --dump Foo.html) + +# GPL +PERMIT_PACKAGE_CDROM= Yes +PERMIT_PACKAGE_FTP= Yes +PERMIT_DISTFILES_CDROM= Yes +PERMIT_DISTFILES_FTP= Yes + +.include diff --git a/devel/idoc/distinfo b/devel/idoc/distinfo new file mode 100644 index 00000000000..49534cf019d --- /dev/null +++ b/devel/idoc/distinfo @@ -0,0 +1,3 @@ +MD5 (idoc-0.2.6.tar.gz) = 5acb412b8fe0c13a9818f2b84c9637c4 +RMD160 (idoc-0.2.6.tar.gz) = 6c93916587a7b0df41bdf19fcb91951fb4123351 +SHA1 (idoc-0.2.6.tar.gz) = e886533eda05bcaafbac8d66d01bb9975e95a372 diff --git a/devel/idoc/pkg/DESCR b/devel/idoc/pkg/DESCR new file mode 100644 index 00000000000..e762e161915 --- /dev/null +++ b/devel/idoc/pkg/DESCR @@ -0,0 +1,7 @@ +IDoc extracts interface documentation and declarations from Haskell +modules based on standard Haskell layout rules and a small number of +clues that the programmer may embed in interface comments. These +clues have been designed to be visually non-imposing when displaying +the source in a text editor. Interface documentation is rendered in +standard markup languages (currently, only HTML is supported). IDoc +has been designed to be simple to use and install. diff --git a/devel/idoc/pkg/PLIST b/devel/idoc/pkg/PLIST new file mode 100644 index 00000000000..1ac1f0908f1 --- /dev/null +++ b/devel/idoc/pkg/PLIST @@ -0,0 +1,4 @@ +@comment $OpenBSD: PLIST,v 1.1.1.1 2004/05/16 03:21:34 dons Exp $ +bin/idoc +share/doc/idoc/README +@dirrm share/doc/idoc