A

From 33ab68b67ce865cd6447b41eda6d64ed0f65e8d9 Mon Sep 17 00:00:00 2001 From: David Waern Date: Sat, 12 Apr 2008 18:57:23 +0000 Subject: Simplify test suite and add tests I move all tests into one single directory to simplify things, and add a test for the last bug that was fixed. --- tests/pre-2.0-tests/A.hs | 2 - tests/pre-2.0-tests/A.html.ref | 116 -- tests/pre-2.0-tests/B.hs | 2 - tests/pre-2.0-tests/B.html.ref | 86 - tests/pre-2.0-tests/Bug1.hs | 6 - tests/pre-2.0-tests/Bug1.html.ref | 150 -- tests/pre-2.0-tests/Bug2.hs | 4 - tests/pre-2.0-tests/Bug2.html.ref | 90 - tests/pre-2.0-tests/Bug3.hs | 6 - tests/pre-2.0-tests/Bug3.html.ref | 114 -- tests/pre-2.0-tests/Bug4.hs | 5 - tests/pre-2.0-tests/Bug4.html.ref | 113 -- tests/pre-2.0-tests/Bug6.hs | 23 - tests/pre-2.0-tests/Bug6.html.ref | 482 ----- tests/pre-2.0-tests/Bug7.hs | 12 - tests/pre-2.0-tests/Bug7.html.ref | 242 --- tests/pre-2.0-tests/Bug8.hs | 17 - tests/pre-2.0-tests/Bug8.html.ref | 128 -- tests/pre-2.0-tests/Hash.hs | 51 - tests/pre-2.0-tests/Hash.html.ref | 412 ----- tests/pre-2.0-tests/Hidden.hs | 4 - tests/pre-2.0-tests/Hidden.html.ref | 88 - tests/pre-2.0-tests/NoLayout.hs | 12 - tests/pre-2.0-tests/NoLayout.html.ref | 113 -- tests/pre-2.0-tests/Test.hs | 410 ----- tests/pre-2.0-tests/Test.html.ref | 3105 --------------------------------- tests/pre-2.0-tests/Visible.hs | 3 - tests/pre-2.0-tests/Visible.html.ref | 88 - 28 files changed, 5884 deletions(-) delete mode 100644 tests/pre-2.0-tests/A.hs delete mode 100644 tests/pre-2.0-tests/A.html.ref delete mode 100644 tests/pre-2.0-tests/B.hs delete mode 100644 tests/pre-2.0-tests/B.html.ref delete mode 100644 tests/pre-2.0-tests/Bug1.hs delete mode 100644 tests/pre-2.0-tests/Bug1.html.ref delete mode 100644 tests/pre-2.0-tests/Bug2.hs delete mode 100644 tests/pre-2.0-tests/Bug2.html.ref delete mode 100644 tests/pre-2.0-tests/Bug3.hs delete mode 100644 tests/pre-2.0-tests/Bug3.html.ref delete mode 100644 tests/pre-2.0-tests/Bug4.hs delete mode 100644 tests/pre-2.0-tests/Bug4.html.ref delete mode 100644 tests/pre-2.0-tests/Bug6.hs delete mode 100644 tests/pre-2.0-tests/Bug6.html.ref delete mode 100644 tests/pre-2.0-tests/Bug7.hs delete mode 100644 tests/pre-2.0-tests/Bug7.html.ref delete mode 100644 tests/pre-2.0-tests/Bug8.hs delete mode 100644 tests/pre-2.0-tests/Bug8.html.ref delete mode 100644 tests/pre-2.0-tests/Hash.hs delete mode 100644 tests/pre-2.0-tests/Hash.html.ref delete mode 100644 tests/pre-2.0-tests/Hidden.hs delete mode 100644 tests/pre-2.0-tests/Hidden.html.ref delete mode 100644 tests/pre-2.0-tests/NoLayout.hs delete mode 100644 tests/pre-2.0-tests/NoLayout.html.ref delete mode 100644 tests/pre-2.0-tests/Test.hs delete mode 100644 tests/pre-2.0-tests/Test.html.ref delete mode 100644 tests/pre-2.0-tests/Visible.hs delete mode 100644 tests/pre-2.0-tests/Visible.html.ref (limited to 'tests/pre-2.0-tests') diff --git a/tests/pre-2.0-tests/A.hs b/tests/pre-2.0-tests/A.hs deleted file mode 100644 index 4a344a24..00000000 --- a/tests/pre-2.0-tests/A.hs +++ /dev/null @@ -1,2 +0,0 @@ -module A where -data A = A diff --git a/tests/pre-2.0-tests/A.html.ref b/tests/pre-2.0-tests/A.html.ref deleted file mode 100644 index 598bf23c..00000000 --- a/tests/pre-2.0-tests/A.html.ref +++ /dev/null @@ -1,116 +0,0 @@ - - -A

Documentation

data A

Constructors

Produced by Haddock version 2.0.0.0

diff --git a/tests/pre-2.0-tests/B.hs b/tests/pre-2.0-tests/B.hs deleted file mode 100644 index 3a31507e..00000000 --- a/tests/pre-2.0-tests/B.hs +++ /dev/null @@ -1,2 +0,0 @@ -module B ( module A ) where -import A diff --git a/tests/pre-2.0-tests/B.html.ref b/tests/pre-2.0-tests/B.html.ref deleted file mode 100644 index 8ff0218d..00000000 --- a/tests/pre-2.0-tests/B.html.ref +++ /dev/null @@ -1,86 +0,0 @@ - - -B

Documentation

module A

Produced by Haddock version 2.0.0.0

diff --git a/tests/pre-2.0-tests/Bug1.hs b/tests/pre-2.0-tests/Bug1.hs deleted file mode 100644 index af1ed4d3..00000000 --- a/tests/pre-2.0-tests/Bug1.hs +++ /dev/null @@ -1,6 +0,0 @@ -module Bug1 where - --- | We should have different anchors for constructors and types\/classes. This --- hyperlink should point to the type constructor by default: 'T'. -data T = T - diff --git a/tests/pre-2.0-tests/Bug1.html.ref b/tests/pre-2.0-tests/Bug1.html.ref deleted file mode 100644 index 7160bdaf..00000000 --- a/tests/pre-2.0-tests/Bug1.html.ref +++ /dev/null @@ -1,150 +0,0 @@ - - -Bug1

Contents

Index

Bug1

Synopsis

data T = T

Documentation

data T

We should have different anchors for constructors and types/classes. This - hyperlink should point to the type constructor by default: T. -

Constructors

Produced by Haddock version 2.0.0.0

diff --git a/tests/pre-2.0-tests/Bug2.hs b/tests/pre-2.0-tests/Bug2.hs deleted file mode 100644 index 9121922e..00000000 --- a/tests/pre-2.0-tests/Bug2.hs +++ /dev/null @@ -1,4 +0,0 @@ -module Bug2 ( x ) where -import B -x :: A -x = A diff --git a/tests/pre-2.0-tests/Bug2.html.ref b/tests/pre-2.0-tests/Bug2.html.ref deleted file mode 100644 index d06e84ee..00000000 --- a/tests/pre-2.0-tests/Bug2.html.ref +++ /dev/null @@ -1,90 +0,0 @@ - - -Bug2

Bug2

Documentation

x :: A

Produced by Haddock version 2.0.0.0

diff --git a/tests/pre-2.0-tests/Bug3.hs b/tests/pre-2.0-tests/Bug3.hs deleted file mode 100644 index 67e57892..00000000 --- a/tests/pre-2.0-tests/Bug3.hs +++ /dev/null @@ -1,6 +0,0 @@ -module Bug3 where - --- | /multi-line --- emphasis/ -foo :: Int -foo = undefined diff --git a/tests/pre-2.0-tests/Bug3.html.ref b/tests/pre-2.0-tests/Bug3.html.ref deleted file mode 100644 index a5a03f3d..00000000 --- a/tests/pre-2.0-tests/Bug3.html.ref +++ /dev/null @@ -1,114 +0,0 @@ - - -Bug3

Bug3

Synopsis

foo :: Int

Documentation

foo :: Int

/multi-line - emphasis/ -

Produced by Haddock version 2.0.0.0

diff --git a/tests/pre-2.0-tests/Bug4.hs b/tests/pre-2.0-tests/Bug4.hs deleted file mode 100644 index 425a77aa..00000000 --- a/tests/pre-2.0-tests/Bug4.hs +++ /dev/null @@ -1,5 +0,0 @@ -module Bug4 where --- | don't use apostrophe's in the wrong place's -foo :: Int -foo = undefined - diff --git a/tests/pre-2.0-tests/Bug4.html.ref b/tests/pre-2.0-tests/Bug4.html.ref deleted file mode 100644 index 75a0b740..00000000 --- a/tests/pre-2.0-tests/Bug4.html.ref +++ /dev/null @@ -1,113 +0,0 @@ - - -Bug4

Bug4

Synopsis

foo :: Int

Documentation

foo :: Int

don't use apostrophe's in the wrong place's -

Produced by Haddock version 2.0.0.0

diff --git a/tests/pre-2.0-tests/Bug6.hs b/tests/pre-2.0-tests/Bug6.hs deleted file mode 100644 index 498983df..00000000 --- a/tests/pre-2.0-tests/Bug6.hs +++ /dev/null @@ -1,23 +0,0 @@ --- | Exporting records. -module Bug6( A(A), B(B), b, C(C,c1,c2), D(D,d1), E(E) ) where - --- | --- This record is exported without its field -data A = A { a :: Int } - --- | --- .. with its field, but the field is named separately in the export list --- (should still be visible as a field name) -data B = B { b :: Int } - --- | --- .. with fields names as subordinate names in the export -data C = C { c1 :: Int, c2 :: Int } - --- | --- .. with only some of the fields exported (we can't handle this one - --- how do we render the declaration?) -data D = D { d1 :: Int, d2 :: Int } - --- | a newtype with a field -newtype E = E { e :: Int } diff --git a/tests/pre-2.0-tests/Bug6.html.ref b/tests/pre-2.0-tests/Bug6.html.ref deleted file mode 100644 index 7fe93681..00000000 --- a/tests/pre-2.0-tests/Bug6.html.ref +++ /dev/null @@ -1,482 +0,0 @@ - - -Bug6

Bug6

Description

Exporting records. -

Synopsis

data A = A Int

data B = B {

b :: Int

}

b :: B -> Int

data C = C {

c1 :: Int

c2 :: Int

}

data D = D Int Int

newtype E = E Int

Documentation

data A

This record is exported without its field -

Constructors

A Int

data B

.. with its field, but the field is named separately in the export list - (should still be visible as a field name) -

Constructors

b :: Int

b :: B -> Int

data C

.. with fields names as subordinate names in the export -

Constructors

c1 :: Int
c2 :: Int

data D

.. with only some of the fields exported (we can't handle this one - - how do we render the declaration?) -

Constructors

D Int Int

newtype E

a newtype with a field -

Constructors

E Int

Produced by Haddock version 2.0.0.0

diff --git a/tests/pre-2.0-tests/Bug7.hs b/tests/pre-2.0-tests/Bug7.hs deleted file mode 100644 index 8cf57914..00000000 --- a/tests/pre-2.0-tests/Bug7.hs +++ /dev/null @@ -1,12 +0,0 @@ --- | This module caused a duplicate instance in the documentation for the Foo --- type. -module Bug7 where - --- | The Foo datatype -data Foo = Foo - --- | The Bar class -class Bar x y - --- | Just one instance -instance Bar Foo Foo diff --git a/tests/pre-2.0-tests/Bug7.html.ref b/tests/pre-2.0-tests/Bug7.html.ref deleted file mode 100644 index d2014754..00000000 --- a/tests/pre-2.0-tests/Bug7.html.ref +++ /dev/null @@ -1,242 +0,0 @@ - - -Bug7

Bug7

Description

This module caused a duplicate instance in the documentation for the Foo - type. -

Synopsis

data Foo = Foo

class Bar x y

Documentation

data Foo

The Foo datatype -

Constructors

Foo

Instances

Bar Foo Foo

class Bar x y

The Bar class -

Instances

Bar Foo Foo

Produced by Haddock version 2.0.0.0

diff --git a/tests/pre-2.0-tests/Bug8.hs b/tests/pre-2.0-tests/Bug8.hs deleted file mode 100644 index 0f279c29..00000000 --- a/tests/pre-2.0-tests/Bug8.hs +++ /dev/null @@ -1,17 +0,0 @@ -{- Note that declarations without type signatures are not included in the - documentation. They could be, but that's a missing feature. -} - -module Bug8 where - -infix --> -infix ---> - -data Typ = Type (String,[Typ]) - | TFree (String, [String]) - -x --> y = Type("fun",[s,t]) -(--->) = flip $ foldr (-->) - -s = undefined -t = undefined -main = undefined diff --git a/tests/pre-2.0-tests/Bug8.html.ref b/tests/pre-2.0-tests/Bug8.html.ref deleted file mode 100644 index 34a57f14..00000000 --- a/tests/pre-2.0-tests/Bug8.html.ref +++ /dev/null @@ -1,128 +0,0 @@ - - -Bug8

Bug8

Documentation

data Typ

Constructors

Type (String, [Typ])
TFree (String, [String])

Produced by Haddock version 2.0.0.0

diff --git a/tests/pre-2.0-tests/Hash.hs b/tests/pre-2.0-tests/Hash.hs deleted file mode 100644 index 7d6506f9..00000000 --- a/tests/pre-2.0-tests/Hash.hs +++ /dev/null @@ -1,51 +0,0 @@ -{- | - Implementation of fixed-size hash tables, with a type - class for constructing hash values for structured types. --} -module Hash ( - -- * The @HashTable@ type - HashTable, - - -- ** Operations on @HashTable@s - new, insert, lookup, - - -- * The @Hash@ class - Hash(..), - ) where - -import Array -import Prelude hiding (lookup) - --- | A hash table with keys of type @key@ and values of type @val@. --- The type @key@ should be an instance of 'Eq'. -data HashTable key val = HashTable Int (Array Int [(key,val)]) - --- | Builds a new hash table with a given size -new :: (Eq key, Hash key) => Int -> IO (HashTable key val) -new = undefined - --- | Inserts a new element into the hash table -insert :: (Eq key, Hash key) => key -> val -> IO () -insert = undefined - --- | Looks up a key in the hash table, returns @'Just' val@ if the key --- was found, or 'Nothing' otherwise. -lookup :: Hash key => key -> IO (Maybe val) -lookup = undefined - --- | A class of types which can be hashed. -class Hash a where - -- | hashes the value of type @a@ into an 'Int' - hash :: a -> Int - -instance Hash Int where - hash = id - -instance Hash Float where - hash = trunc - -instance (Hash a, Hash b) => Hash (a,b) where - hash (a,b) = hash a `xor` hash b - -trunc = undefined -xor = undefined diff --git a/tests/pre-2.0-tests/Hash.html.ref b/tests/pre-2.0-tests/Hash.html.ref deleted file mode 100644 index c1034171..00000000 --- a/tests/pre-2.0-tests/Hash.html.ref +++ /dev/null @@ -1,412 +0,0 @@ - - -Hash

Contents

Index

Hash

Contents

The HashTable type -

Operations on HashTables -

The Hash class -

Description

Implementation of fixed-size hash tables, with a type - class for constructing hash values for structured types. -

Synopsis

data HashTable key val

new :: (Eq key, Hash key) => Int -> IO (HashTable key val)

insert :: (Eq key, Hash key) => key -> val -> IO ()

lookup :: Hash key => key -> IO (Maybe val)

class Hash a where

hash :: a -> Int

The HashTable type -

data HashTable key val

A hash table with keys of type key and values of type val. - The type key should be an instance of Eq. -

Operations on HashTables -

new :: (Eq key, Hash key) => Int -> IO (HashTable key val)

Builds a new hash table with a given size -

insert :: (Eq key, Hash key) => key -> val -> IO ()

Inserts a new element into the hash table -

lookup :: Hash key => key -> IO (Maybe val)

Looks up a key in the hash table, returns Just val if the key - was found, or Nothing otherwise. -

The Hash class -

class Hash a where

A class of types which can be hashed. -

Methods

hash :: a -> Int

hashes the value of type a into an Int -

Produced by Haddock version 2.0.0.0

diff --git a/tests/pre-2.0-tests/Hidden.hs b/tests/pre-2.0-tests/Hidden.hs deleted file mode 100644 index e46fc37f..00000000 --- a/tests/pre-2.0-tests/Hidden.hs +++ /dev/null @@ -1,4 +0,0 @@ -{-# OPTIONS_HADDOCK hide #-} -module Hidden where -hidden :: Int -> Int -hidden a = a diff --git a/tests/pre-2.0-tests/Hidden.html.ref b/tests/pre-2.0-tests/Hidden.html.ref deleted file mode 100644 index 2e4acc71..00000000 --- a/tests/pre-2.0-tests/Hidden.html.ref +++ /dev/null @@ -1,88 +0,0 @@ - - -Hidden

Hidden

Documentation

hidden :: Int -> Int

Produced by Haddock version 2.0.0.0

diff --git a/tests/pre-2.0-tests/NoLayout.hs b/tests/pre-2.0-tests/NoLayout.hs deleted file mode 100644 index ac8e58bb..00000000 --- a/tests/pre-2.0-tests/NoLayout.hs +++ /dev/null @@ -1,12 +0,0 @@ - --- Haddock comments are parsed as separate declarations so we --- need to insert a ';' when using them with explicit layout. --- This should probably be changed. - -module NoLayout where { - -- | the class 'C' - ; - g :: Int; - g = undefined - } - diff --git a/tests/pre-2.0-tests/NoLayout.html.ref b/tests/pre-2.0-tests/NoLayout.html.ref deleted file mode 100644 index b0a862cc..00000000 --- a/tests/pre-2.0-tests/NoLayout.html.ref +++ /dev/null @@ -1,113 +0,0 @@ - - -NoLayout

NoLayout

Synopsis

g :: Int

Documentation

g :: Int

the class C -

Produced by Haddock version 2.0.0.0

diff --git a/tests/pre-2.0-tests/Test.hs b/tests/pre-2.0-tests/Test.hs deleted file mode 100644 index 230f32d8..00000000 --- a/tests/pre-2.0-tests/Test.hs +++ /dev/null @@ -1,410 +0,0 @@ ------------------------------------------------------------------------------ --- | --- Module : Test --- Copyright : (c) Simon Marlow 2002 --- License : BSD-style --- --- Maintainer : libraries@haskell.org --- Stability : provisional --- Portability : portable --- --- This module illustrates & tests most of the features of Haddock. --- Testing references from the description: 'T', 'f', 'g', 'Visible.visible'. --- ------------------------------------------------------------------------------ - --- This is plain comment, ignored by Haddock. - -module Test ( - - -- Section headings are introduced with '-- *': - -- * Type declarations - - -- Subsection headings are introduced with '-- **' and so on. - -- ** Data types - T(..), T2, T3(..), T4(..), T5(..), T6(..), - N1(..), N2(..), N3(..), N4, N5(..), N6(..), N7(..), - - -- ** Records - R(..), R1(..), - - -- | test that we can export record selectors on their own: - p, q, u, - - -- * Class declarations - C(a,b), D(..), E, F(..), - - -- | Test that we can export a class method on its own: - a, - - -- * Function types - f, g, - - -- * Auxiliary stuff - - -- $aux1 - - -- $aux2 - - -- $aux3 - - -- $aux4 - - -- $aux5 - - -- $aux6 - - -- $aux7 - - -- $aux8 - - -- $aux9 - - -- $aux10 - - -- $aux11 - - -- $aux12 - - -- | This is some inline documentation in the export list - -- - -- > a code block using bird-tracks - -- > each line must begin with > (which isn't significant unless it - -- > is at the beginning of the line). - - -- * A hidden module - module Hidden, - - -- * A visible module - module Visible, - - {-| nested-style doc comments -} - - -- * Existential \/ Universal types - Ex(..), - - -- * Type signatures with argument docs - k, l, m, o, - - -- * A section - -- and without an intervening comma: - -- ** A subsection - -{-| - > a literal line - - $ a non /literal/ line $ --} - - f' - ) where - -import Hidden -import Visible -import Data.Maybe - -bla = Nothing - --- | This comment applies to the /following/ declaration --- and it continues until the next non-comment line -data T a b - = A Int (Maybe Float) -- ^ This comment describes the 'A' constructor - | -- | This comment describes the 'B' constructor - B (T a b, T Int Float) -- ^ - --- | An abstract data declaration -data T2 a b = T2 a b - --- | A data declaration with no documentation annotations on the constructors -data T3 a b = A1 a | B1 b - --- A data declaration with no documentation annotations at all -data T4 a b = A2 a | B2 b - --- A data declaration documentation on the constructors only -data T5 a b - = A3 a -- ^ documents 'A3' - | B3 b -- ^ documents 'B3' - --- | Testing alternative comment styles -data T6 - -- | This is the doc for 'A4' - = A4 - | B4 - | -- ^ This is the doc for 'B4' - - -- | This is the doc for 'C4' - C4 - --- | A newtype -newtype N1 a = N1 a - --- | A newtype with a fieldname -newtype N2 a b = N2 {n :: a b} - --- | A newtype with a fieldname, documentation on the field -newtype N3 a b = N3 {n3 :: a b -- ^ this is the 'n3' field - } - --- | An abstract newtype - we show this one as data rather than newtype because --- the difference isn\'t visible to the programmer for an abstract type. -newtype N4 a b = N4 a - -newtype N5 a b = N5 {n5 :: a b -- ^ no docs on the datatype or the constructor - } - -newtype N6 a b = N6 {n6 :: a b - } - -- ^ docs on the constructor only - --- | docs on the newtype and the constructor -newtype N7 a b = N7 {n7 :: a b - } - -- ^ The 'N7' constructor - - -class (D a) => C a where - -- |this is a description of the 'a' method - a :: IO a - b :: [a] - -- ^ this is a description of the 'b' method - c :: a -- c is hidden in the export list - --- ^ This comment applies to the /previous/ declaration (the 'C' class) - -class D a where - d :: T a b - e :: (a,a) --- ^ This is a class declaration with no separate docs for the methods - -instance D Int where - d = undefined - e = undefined - --- instance with a qualified class name -instance Test.D Float where - d = undefined - e = undefined - -class E a where - ee :: a --- ^ This is a class declaration with no methods (or no methods exported) - --- This is a class declaration with no documentation at all -class F a where - ff :: a - --- | This is the documentation for the 'R' record, which has four fields, --- 'p', 'q', 'r', and 's'. -data R = - -- | This is the 'C1' record constructor, with the following fields: - C1 { p :: Int -- ^ This comment applies to the 'p' field - , q :: forall a . a->a -- ^ This comment applies to the 'q' field - , -- | This comment applies to both 'r' and 's' - r,s :: Int - } - | C2 { t :: T1 -> (T2 Int Int)-> (T3 Bool Bool) -> (T4 Float Float) -> T5 () (), - u,v :: Int - } - -- ^ This is the 'C2' record constructor, also with some fields: - --- | Testing different record commenting styles -data R1 - -- | This is the 'C3' record constructor - = C3 { - -- | The 's1' record selector - s1 :: Int - -- | The 's2' record selector - , s2 :: Int - , s3 :: Int -- NOTE: In the original examples/Test.hs in Haddock, there is an extra "," here. - -- Since GHC doesn't allow that, I have removed it in this file. - -- ^ The 's3' record selector - } - --- These section headers are only used when there is no export list to --- give the structure of the documentation: - --- * This is a section header (level 1) --- ** This is a section header (level 2) --- *** This is a section header (level 3) - -{-| -In a comment string we can refer to identifiers in scope with -single quotes like this: 'T', and we can refer to modules by -using double quotes: "Foo". We can add emphasis /like this/. - - * This is a bulleted list - - - This is the next item (different kind of bullet) - - (1) This is an ordered list - - 2. This is the next item (different kind of bullet) - -@ - This is a block of code, which can include other markup: 'R' - formatting - is - significant -@ - -> this is another block of code - -We can also include URLs in documentation: . --} - -f :: C a => a -> Int - --- | we can export foreign declarations too -foreign import ccall g :: Int -> IO CInt - --- | this doc string has a parse error in it: \' -h :: Int -h = 42 - - --- $aux1 This is some documentation that is attached to a name ($aux1) --- rather than a source declaration. The documentation may be --- referred to in the export list using its name. --- --- @ code block in named doc @ - --- $aux2 This is some documentation that is attached to a name ($aux2) - --- $aux3 --- @ code block on its own in named doc @ - --- $aux4 --- --- @ code block on its own in named doc (after newline) @ - -{- $aux5 a nested, named doc comment - - with a paragraph, - - @ and a code block @ --} - --- some tests for various arrangements of code blocks: - -{- $aux6 ->test ->test1 - -@ test2 - test3 -@ --} - -{- $aux7 -@ -test1 -test2 -@ --} - -{- $aux8 ->test3 ->test4 --} - -{- $aux9 -@ -test1 -test2 -@ - ->test3 ->test4 --} - -{- $aux10 ->test3 ->test4 - -@ -test1 -test2 -@ --} - --- This one is currently wrong (Haddock 0.4). The @...@ part is --- interpreted as part of the bird-tracked code block. -{- $aux11 -aux11: - ->test3 ->test4 - -@ -test1 -test2 -@ --} - --- $aux12 --- > foo --- --- > bar --- - --- | A data-type using existential\/universal types -data Ex a - = forall b . C b => Ex1 b - | forall b . Ex2 b - | forall b . C a => Ex3 b -- NOTE: I have added "forall b" here make GHC accept this file - | Ex4 (forall a . a -> a) - --- | This is a function with documentation for each argument -k :: T () () -- ^ This argument has type 'T' - -> (T2 Int Int) -- ^ This argument has type 'T2 Int Int' - -> (T3 Bool Bool -> T4 Float Float) -- ^ This argument has type @T3 Bool Bool -> T4 Float Float@ - -> T5 () () -- ^ This argument has a very long description that should - -- hopefully cause some wrapping to happen when it is finally - -- rendered by Haddock in the generated HTML page. - -> IO () -- ^ This is the result type - --- This function has arg docs but no docs for the function itself -l :: (Int, Int, Float) -- ^ takes a triple - -> Int -- ^ returns an 'Int' - --- | This function has some arg docs -m :: R - -> N1 () -- ^ one of the arguments - -> IO Int -- ^ and the return value - --- | This function has some arg docs but not a return value doc - --- can't use the original name ('n') with GHC -newn :: R -- ^ one of the arguments, an 'R' - -> N1 () -- ^ one of the arguments - -> IO Int -newn = undefined - - --- | A foreign import with argument docs -foreign import ccall unsafe - o :: Float -- ^ The input float - -> IO Float -- ^ The output float - --- | We should be able to escape this: \#\#\# - --- p :: Int --- can't use the above original definition with GHC -newp :: Int -newp = undefined - --- | a function with a prime can be referred to as 'f'' --- but f' doesn't get link'd 'f\'' -f' :: Int - - --- Add some definitions here so that this file can be compiled with GHC - -data T1 -f = undefined -f' = undefined -type CInt = Int -k = undefined -l = undefined -m = undefined diff --git a/tests/pre-2.0-tests/Test.html.ref b/tests/pre-2.0-tests/Test.html.ref deleted file mode 100644 index 50df8e7e..00000000 --- a/tests/pre-2.0-tests/Test.html.ref +++ /dev/null @@ -1,3105 +0,0 @@ - - -Test

Contents

Index

Test

Portability	portable
Stability	provisional
Maintainer	libraries@haskell.org

Contents

Type declarations -

Data types -
Records -

Class declarations -

Function types -

Auxiliary stuff -

A hidden module -

A visible module -

Existential / Universal types -

Type signatures with argument docs -

A section -

A subsection -

Description

This module illustrates & tests most of the features of Haddock. - Testing references from the description: T, f, g, visible. -

Synopsis

data T a b

= A Int Maybe Float

| B (T a b, T Int Float)

data T2 a b

data T3 a b

= A1 a

| B1 b

data T4 a b

= A2 a

| B2 b

data T5 a b

= A3 a

| B3 b

data T6

= A4

| B4

| C4

newtype N1 a = N1 a

newtype N2 a b = N2 {

n :: a b

}

newtype N3 a b = N3 {

n3 :: a b

}

data N4 a b

newtype N5 a b = N5 {

n5 :: a b

}

newtype N6 a b = N6 {

n6 :: a b

}

newtype N7 a b = N7 {

n7 :: a b

}

data R

= C1 {

p :: Int

q :: forall a. a -> a

r :: Int

s :: Int

}

| C2 {

t :: T1 -> (T2 Int Int) -> (T3 Bool Bool) -> (T4 Float Float) -> T5 () ()

u :: Int

v :: Int

}

data R1 = C3 {

s1 :: Int

s2 :: Int

s3 :: Int

}

p :: R -> Int

q :: R -> forall a. a -> a

u :: R -> Int

class D a => C a where

a :: IO a

b :: [a]

class D a where

d :: T a b

e :: (a, a)

class E a

class F a where

ff :: a

a :: C a => IO a

f :: C a => a -> Int

g :: Int -> IO CInt

hidden :: Int -> Int

module Visible

data Ex a

= forall b . C b => Ex1 b

| forall b . Ex2 b

| forall b . C a => Ex3 b

| Ex4 forall a. a -> a

k :: T () () -> T2 Int Int -> T3 Bool Bool -> T4 Float Float -> T5 () () -> IO ()

l :: (Int, Int, Float) -> Int

m :: R -> N1 () -> IO Int

o :: Float -> IO Float

f' :: Int

Type declarations -

Data types -

data T a b

This comment applies to the following declaration - and it continues until the next non-comment line -

Constructors

A Int Maybe Float	This comment describes the `A` constructor -
B (T a b, T Int Float)	This comment describes the `B` constructor -

data T2 a b

An abstract data declaration -

data T3 a b

A data declaration with no documentation annotations on the constructors -

Constructors

A1 a
B1 b

data T4 a b

Constructors

A2 a
B2 b

data T5 a b

Constructors

A3 a	documents `A3` -
B3 b	documents `B3` -

data T6

Testing alternative comment styles -

Constructors

A4	This is the doc for `A4` -
B4	This is the doc for `B4` -
C4	This is the doc for `C4` -

newtype N1 a

A newtype -

Constructors

N1 a

newtype N2 a b

A newtype with a fieldname -

Constructors

n :: a b

newtype N3 a b

A newtype with a fieldname, documentation on the field -

Constructors

n3 :: a b this is the n3 field -

data N4 a b

An abstract newtype - we show this one as data rather than newtype because - the difference isn't visible to the programmer for an abstract type. -

newtype N5 a b

Constructors

n5 :: a b

no docs on the datatype or the constructor -

newtype N6 a b

Constructors

docs on the constructor only -

n6 :: a b

newtype N7 a b

docs on the newtype and the constructor -

Constructors

N7 The N7 constructor -

n7 :: a b

Records -

data R

This is the documentation for the R record, which has four fields, - p, q, r, and s. -

Constructors

C1 This is the C1 record constructor, with the following fields: -

p :: Int	This comment applies to the `p` field -
q :: forall a. a -> a	This comment applies to the `q` field -
r :: Int	This comment applies to both `r` and `s` -
s :: Int	This comment applies to both `r` and `s` -

C2 This is the C2 record constructor, also with some fields: -

t :: T1 -> (T2 Int Int) -> (T3 Bool Bool) -> (T4 Float Float) -> T5 () ()
u :: Int
v :: Int

data R1

Testing different record commenting styles -

Constructors

C3 This is the C3 record constructor -

s1 :: Int	The `s1` record selector -
s2 :: Int	The `s2` record selector -
s3 :: Int	The `s3` record selector -

test that we can export record selectors on their own: -

p :: R -> Int

This comment applies to the p field -

q :: R -> forall a. a -> a

This comment applies to the q field -

u :: R -> Int

Class declarations -

class D a => C a where

This comment applies to the previous declaration (the C class) -

Methods

a :: IO a

this is a description of the a method -

b :: [a]

this is a description of the b method -

class D a where

This is a class declaration with no separate docs for the methods -

Methods

d :: T a b

e :: (a, a)

class E a

This is a class declaration with no methods (or no methods exported) -

class F a where

Methods

ff :: a

Test that we can export a class method on its own: -

a :: C a => IO a

this is a description of the a method -

Function types -

f :: C a => a -> Int

In a comment string we can refer to identifiers in scope with -single quotes like this: T, and we can refer to modules by -using double quotes: Foo. We can add emphasis like this. -

This is a bulleted list -
This is the next item (different kind of bullet) -

This is an ordered list -

2. This is the next item (different kind of bullet) -

-     This is a block of code, which can include other markup: R
-     formatting
-               is
-                 significant
-

 this is another block of code
-

We can also include URLs in documentation: http://www.haskell.org/. -

g :: Int -> IO CInt

we can export foreign declarations too -

Auxiliary stuff -

This is some documentation that is attached to a name ($aux1) - rather than a source declaration. The documentation may be - referred to in the export list using its name. -

 code block in named doc

This is some documentation that is attached to a name ($aux2) -

 code block on its own in named doc

 code block on its own in named doc (after newline)

a nested, named doc comment -

with a paragraph, -

 and a code block

test
-test1
-

 test2
-  test3
-

-test1
-test2
-

test3
-test4
-

-test1
-test2
-

test3
-test4
-

test3
-test4
-

-test1
-test2
-

aux11: -

test3
-test4
-

-test1
-test2
-

 foo
-

 bar
-

This is some inline documentation in the export list -

 a code block using bird-tracks
- each line must begin with > (which isn't significant unless it
- is at the beginning of the line).
-

A hidden module -

hidden :: Int -> Int

A visible module -

module Visible

nested-style doc comments -

Existential / Universal types -

data Ex a

A data-type using existential/universal types -

Constructors

forall b . C b => Ex1 b
forall b . Ex2 b
forall b . C a => Ex3 b
Ex4 forall a. a -> a

Type signatures with argument docs -

:: T () ()	This argument has type `T` -
-> T2 Int Int	This argument has type 'T2 Int Int' -
-> T3 Bool Bool -> T4 Float Float	This argument has type `T3 Bool Bool -> T4 Float Float` -
-> T5 () ()	This argument has a very long description that should - hopefully cause some wrapping to happen when it is finally - rendered by Haddock in the generated HTML page. -
-> IO ()	This is the result type -
This is a function with documentation for each argument -

:: (Int, Int, Float)	takes a triple -
-> Int	returns an `Int` -

:: R
-> N1 ()	one of the arguments -
-> IO Int	and the return value -
This function has some arg docs -

:: Float	The input float -
-> IO Float	The output float -
A foreign import with argument docs -

A section -

A subsection -

 a literal line
-

$ a non literal line $ -

f' :: Int

a function with a prime can be referred to as f' - but f' doesn't get link'd 'f\'' -

Produced by Haddock version 2.0.0.0

diff --git a/tests/pre-2.0-tests/Visible.hs b/tests/pre-2.0-tests/Visible.hs deleted file mode 100644 index cad71931..00000000 --- a/tests/pre-2.0-tests/Visible.hs +++ /dev/null @@ -1,3 +0,0 @@ -module Visible where -visible :: Int -> Int -visible a = a diff --git a/tests/pre-2.0-tests/Visible.html.ref b/tests/pre-2.0-tests/Visible.html.ref deleted file mode 100644 index 9561baee..00000000 --- a/tests/pre-2.0-tests/Visible.html.ref +++ /dev/null @@ -1,88 +0,0 @@ - - -Visible

Visible

Documentation

visible :: Int -> Int

Produced by Haddock version 2.0.0.0

-- cgit v1.2.3