summaryrefslogtreecommitdiff
path: root/src/haddock
diff options
context:
space:
mode:
authorpeb <unknown>2005-02-18 18:21:06 +0000
committerpeb <unknown>2005-02-18 18:21:06 +0000
commit9568d7a844ba6a1872a8e8f6ef002860057e62ab (patch)
tree9e25c6ed62e48101a2782d5fb8dcba68462dc613 /src/haddock
parent1c4f025320900897ae3acdab6982f7d595b98dd1 (diff)
"Committed_by_peb"
Diffstat (limited to 'src/haddock')
-rw-r--r--src/haddock/haddock-check.perl13
-rw-r--r--src/haddock/haddock-script.csh45
2 files changed, 36 insertions, 22 deletions
diff --git a/src/haddock/haddock-check.perl b/src/haddock/haddock-check.perl
index b65fbcc68..81901fa52 100644
--- a/src/haddock/haddock-check.perl
+++ b/src/haddock/haddock-check.perl
@@ -8,8 +8,10 @@
# - transforming hard space to ordinary space
# limitations:
-# - does not check that type aliases are put in the export list
# - there might be some problems with nested comments
+# - cannot handle type signatures for several functions
+# (i.e. "a, b, c :: t")
+# but on the other hand -- haddock has some problems with these too...
$operSym = qr/[\!\#\$\%\&\*\+\.\/\<\=\>\?\@\\\^\|\-\~\:]+/;
$funSym = qr/[a-z]\w*\'*/;
@@ -34,6 +36,15 @@ for $file (@ARGV) {
print "-- $file\n";
+ # substituting hard spaces for ordinary spaces
+ $nchars = tr/\240/ /;
+ if ($nchars > 0) {
+ print " ! Substituted $nchars hard spaces\n";
+ open F, ">$file.hs";
+ print F $_;
+ close F;
+ }
+
# the module header
s/^(--+\s*\n)+//s;
unless (s/^-- \|\s*\n//s) {
diff --git a/src/haddock/haddock-script.csh b/src/haddock/haddock-script.csh
index 54e20e9e3..dd96a0f88 100644
--- a/src/haddock/haddock-script.csh
+++ b/src/haddock/haddock-script.csh
@@ -2,8 +2,8 @@
######################################################################
# Author: Peter Ljunglöf
-# Time-stamp: "2005-02-04, 11:02"
-# CVS $Date: 2005/02/04 10:10:28 $
+# Time-stamp: "2005-02-18, 14:26"
+# CVS $Date: 2005/02/18 19:21:06 $
# CVS $Author: peb $
#
# a script for producing documentation through Haddock
@@ -13,7 +13,9 @@ set base = `pwd`
set docdir = $base/haddock
set resourcedir = $base/haddock-resources
-set dirs = (. api compile grammar infra shell source canonical useGrammar cf newparsing parsers notrace cfgm speech visualization for-hugs for-ghc)
+#set dirs = (. api compile grammar infra shell source canonical useGrammar cf newparsing parsers notrace cfgm speech visualization for-hugs for-ghc)
+
+set files = (`find $base -name '*.hs' -not -path '*/conversions/*' -not -path '*/parsing/*' -not -path '*/for-*' -not -path '*/haddock*' -not -name 'Lex[GC]*' -not -name 'Par[GC]*'` $base/for-ghc-nofud/*.hs)
######################################################################
@@ -21,20 +23,21 @@ echo 1. Creating and cleaning Haddock directory
echo -- $docdir
mkdir -p $docdir
-rm $docdir/*
+rm -r $docdir/*
######################################################################
-echo
-echo 2. Selecting and copying Haskell files
-
-foreach d ($dirs)
- echo -- Directory: $d
- cd $base/$d
- foreach f (*.hs)
- tr "\240" " " < $f > $docdir/$f
- end
-end
+# echo
+# echo 2. Selecting and soft linking Haskell files
+
+# foreach d ($dirs)
+# echo -- Directory: $d
+# cd $base/$d
+# foreach f (*.hs)
+# ln -fs $base/$d/$f $docdir/$f
+# # tr "\240" " " < $f > $docdir/$f
+# end
+# end
######################################################################
@@ -50,15 +53,15 @@ end
######################################################################
echo
-echo 3. Invoking Haddock
+echo 2. Invoking Haddock
-cd $docdir
-haddock -h -t 'Grammatical Framework' *.hs
+# cd $docdir
+haddock -o $docdir -h -t 'Grammatical Framework' $files
######################################################################
echo
-echo 4. Restructuring to HTML framesets
+echo 3. Restructuring to HTML framesets
cd $docdir
echo -- Substituting for frame targets inside html files
@@ -70,13 +73,13 @@ end
cd $resourcedir
echo -- Copying resource files:
-echo -- `ls`
-cp * $docdir
+echo -- `ls *.*`
+cp *.* $docdir
######################################################################
echo
-echo 5. Finished
+echo 4. Finished
echo -- The documentation is located at:
echo -- $docdir/index.html