From f21570e5526ce564ac8abeff5310cf753f86ffb8 Mon Sep 17 00:00:00 2001 From: Simon Hengel Date: Mon, 15 Oct 2012 10:41:29 +0200 Subject: Move HTML reference renderings to /html-test/ref/ --- html-test/ref/A.html | 183 ++ html-test/ref/AdvanceTypes.html | 97 + html-test/ref/B.html | 175 ++ html-test/ref/Bug1.html | 103 + html-test/ref/Bug2.html | 65 + html-test/ref/Bug3.html | 83 + html-test/ref/Bug4.html | 82 + html-test/ref/Bug6.html | 335 +++ html-test/ref/Bug7.html | 173 ++ html-test/ref/Bug8.html | 131 ++ html-test/ref/BugDeprecated.html | 198 ++ html-test/ref/BugExportHeadings.html | 220 ++ html-test/ref/Bugs.html | 81 + html-test/ref/CrossPackageDocs.html | 298 +++ html-test/ref/DeprecatedClass.html | 161 ++ html-test/ref/DeprecatedData.html | 198 ++ html-test/ref/DeprecatedFunction.html | 110 + html-test/ref/DeprecatedFunction2.html | 84 + html-test/ref/DeprecatedFunction3.html | 84 + html-test/ref/DeprecatedModule.html | 83 + html-test/ref/DeprecatedModule2.html | 76 + html-test/ref/DeprecatedNewtype.html | 161 ++ html-test/ref/DeprecatedReExport.html | 133 ++ html-test/ref/DeprecatedRecord.html | 151 ++ html-test/ref/DeprecatedTypeFamily.html | 108 + html-test/ref/DeprecatedTypeSynonym.html | 116 + html-test/ref/DeprecationMessageParseError.html | 101 + html-test/ref/Examples.html | 179 ++ html-test/ref/FunArgs.html | 176 ++ html-test/ref/GADTRecords.html | 234 ++ html-test/ref/Hash.html | 337 +++ html-test/ref/HiddenInstances.html | 169 ++ html-test/ref/HiddenInstancesB.html | 143 ++ html-test/ref/Hyperlinks.html | 89 + html-test/ref/IgnoreExports.html | 101 + html-test/ref/ModuleWithWarning.html | 83 + html-test/ref/NamedDoc.html | 68 + html-test/ref/NoLayout.html | 86 + html-test/ref/NonGreedy.html | 82 + html-test/ref/Properties.html | 92 + html-test/ref/PruneWithWarning.html | 72 + html-test/ref/QuasiExpr.html | 221 ++ html-test/ref/QuasiQuote.html | 65 + html-test/ref/TH.html | 63 + html-test/ref/TH2.html | 63 + html-test/ref/Test.html | 2245 ++++++++++++++++++++ html-test/ref/Ticket112.html | 82 + html-test/ref/Ticket61.html | 80 + html-test/ref/Ticket75.html | 116 + html-test/ref/TypeFamilies.html | 212 ++ html-test/ref/TypeOperators.html | 185 ++ html-test/ref/Unicode.html | 82 + html-test/ref/Visible.html | 67 + html-test/ref/frames.html | 30 + html-test/ref/mini_A.html | 59 + html-test/ref/mini_AdvanceTypes.html | 33 + html-test/ref/mini_B.html | 45 + html-test/ref/mini_Bug1.html | 33 + html-test/ref/mini_Bug2.html | 31 + html-test/ref/mini_Bug3.html | 31 + html-test/ref/mini_Bug4.html | 31 + html-test/ref/mini_Bug6.html | 65 + html-test/ref/mini_Bug7.html | 41 + html-test/ref/mini_Bug8.html | 63 + html-test/ref/mini_BugDeprecated.html | 61 + html-test/ref/mini_BugExportHeadings.html | 79 + html-test/ref/mini_Bugs.html | 33 + html-test/ref/mini_CrossPackageDocs.html | 45 + html-test/ref/mini_DeprecatedClass.html | 41 + html-test/ref/mini_DeprecatedData.html | 41 + html-test/ref/mini_DeprecatedFunction.html | 37 + html-test/ref/mini_DeprecatedFunction2.html | 31 + html-test/ref/mini_DeprecatedFunction3.html | 31 + html-test/ref/mini_DeprecatedModule.html | 31 + html-test/ref/mini_DeprecatedModule2.html | 31 + html-test/ref/mini_DeprecatedNewtype.html | 41 + html-test/ref/mini_DeprecatedReExport.html | 37 + html-test/ref/mini_DeprecatedRecord.html | 33 + html-test/ref/mini_DeprecatedTypeFamily.html | 41 + html-test/ref/mini_DeprecatedTypeSynonym.html | 41 + .../ref/mini_DeprecationMessageParseError.html | 31 + html-test/ref/mini_Examples.html | 31 + html-test/ref/mini_FunArgs.html | 37 + html-test/ref/mini_GADTRecords.html | 33 + html-test/ref/mini_Hash.html | 74 + html-test/ref/mini_HiddenInstances.html | 41 + html-test/ref/mini_HiddenInstancesB.html | 41 + html-test/ref/mini_Hyperlinks.html | 31 + html-test/ref/mini_IgnoreExports.html | 37 + html-test/ref/mini_ModuleWithWarning.html | 31 + html-test/ref/mini_NamedDoc.html | 25 + html-test/ref/mini_NoLayout.html | 31 + html-test/ref/mini_NonGreedy.html | 31 + html-test/ref/mini_Properties.html | 31 + html-test/ref/mini_PruneWithWarning.html | 25 + html-test/ref/mini_QuasiExpr.html | 59 + html-test/ref/mini_QuasiQuote.html | 31 + html-test/ref/mini_TH.html | 31 + html-test/ref/mini_TH2.html | 31 + html-test/ref/mini_Test.html | 269 +++ html-test/ref/mini_Ticket112.html | 31 + html-test/ref/mini_Ticket61.html | 33 + html-test/ref/mini_Ticket75.html | 39 + html-test/ref/mini_TypeFamilies.html | 55 + html-test/ref/mini_TypeOperators.html | 66 + html-test/ref/mini_Unicode.html | 31 + html-test/ref/mini_Visible.html | 31 + 107 files changed, 11535 insertions(+) create mode 100644 html-test/ref/A.html create mode 100644 html-test/ref/AdvanceTypes.html create mode 100644 html-test/ref/B.html create mode 100644 html-test/ref/Bug1.html create mode 100644 html-test/ref/Bug2.html create mode 100644 html-test/ref/Bug3.html create mode 100644 html-test/ref/Bug4.html create mode 100644 html-test/ref/Bug6.html create mode 100644 html-test/ref/Bug7.html create mode 100644 html-test/ref/Bug8.html create mode 100644 html-test/ref/BugDeprecated.html create mode 100644 html-test/ref/BugExportHeadings.html create mode 100644 html-test/ref/Bugs.html create mode 100644 html-test/ref/CrossPackageDocs.html create mode 100644 html-test/ref/DeprecatedClass.html create mode 100644 html-test/ref/DeprecatedData.html create mode 100644 html-test/ref/DeprecatedFunction.html create mode 100644 html-test/ref/DeprecatedFunction2.html create mode 100644 html-test/ref/DeprecatedFunction3.html create mode 100644 html-test/ref/DeprecatedModule.html create mode 100644 html-test/ref/DeprecatedModule2.html create mode 100644 html-test/ref/DeprecatedNewtype.html create mode 100644 html-test/ref/DeprecatedReExport.html create mode 100644 html-test/ref/DeprecatedRecord.html create mode 100644 html-test/ref/DeprecatedTypeFamily.html create mode 100644 html-test/ref/DeprecatedTypeSynonym.html create mode 100644 html-test/ref/DeprecationMessageParseError.html create mode 100644 html-test/ref/Examples.html create mode 100644 html-test/ref/FunArgs.html create mode 100644 html-test/ref/GADTRecords.html create mode 100644 html-test/ref/Hash.html create mode 100644 html-test/ref/HiddenInstances.html create mode 100644 html-test/ref/HiddenInstancesB.html create mode 100644 html-test/ref/Hyperlinks.html create mode 100644 html-test/ref/IgnoreExports.html create mode 100644 html-test/ref/ModuleWithWarning.html create mode 100644 html-test/ref/NamedDoc.html create mode 100644 html-test/ref/NoLayout.html create mode 100644 html-test/ref/NonGreedy.html create mode 100644 html-test/ref/Properties.html create mode 100644 html-test/ref/PruneWithWarning.html create mode 100644 html-test/ref/QuasiExpr.html create mode 100644 html-test/ref/QuasiQuote.html create mode 100644 html-test/ref/TH.html create mode 100644 html-test/ref/TH2.html create mode 100644 html-test/ref/Test.html create mode 100644 html-test/ref/Ticket112.html create mode 100644 html-test/ref/Ticket61.html create mode 100644 html-test/ref/Ticket75.html create mode 100644 html-test/ref/TypeFamilies.html create mode 100644 html-test/ref/TypeOperators.html create mode 100644 html-test/ref/Unicode.html create mode 100644 html-test/ref/Visible.html create mode 100644 html-test/ref/frames.html create mode 100644 html-test/ref/mini_A.html create mode 100644 html-test/ref/mini_AdvanceTypes.html create mode 100644 html-test/ref/mini_B.html create mode 100644 html-test/ref/mini_Bug1.html create mode 100644 html-test/ref/mini_Bug2.html create mode 100644 html-test/ref/mini_Bug3.html create mode 100644 html-test/ref/mini_Bug4.html create mode 100644 html-test/ref/mini_Bug6.html create mode 100644 html-test/ref/mini_Bug7.html create mode 100644 html-test/ref/mini_Bug8.html create mode 100644 html-test/ref/mini_BugDeprecated.html create mode 100644 html-test/ref/mini_BugExportHeadings.html create mode 100644 html-test/ref/mini_Bugs.html create mode 100644 html-test/ref/mini_CrossPackageDocs.html create mode 100644 html-test/ref/mini_DeprecatedClass.html create mode 100644 html-test/ref/mini_DeprecatedData.html create mode 100644 html-test/ref/mini_DeprecatedFunction.html create mode 100644 html-test/ref/mini_DeprecatedFunction2.html create mode 100644 html-test/ref/mini_DeprecatedFunction3.html create mode 100644 html-test/ref/mini_DeprecatedModule.html create mode 100644 html-test/ref/mini_DeprecatedModule2.html create mode 100644 html-test/ref/mini_DeprecatedNewtype.html create mode 100644 html-test/ref/mini_DeprecatedReExport.html create mode 100644 html-test/ref/mini_DeprecatedRecord.html create mode 100644 html-test/ref/mini_DeprecatedTypeFamily.html create mode 100644 html-test/ref/mini_DeprecatedTypeSynonym.html create mode 100644 html-test/ref/mini_DeprecationMessageParseError.html create mode 100644 html-test/ref/mini_Examples.html create mode 100644 html-test/ref/mini_FunArgs.html create mode 100644 html-test/ref/mini_GADTRecords.html create mode 100644 html-test/ref/mini_Hash.html create mode 100644 html-test/ref/mini_HiddenInstances.html create mode 100644 html-test/ref/mini_HiddenInstancesB.html create mode 100644 html-test/ref/mini_Hyperlinks.html create mode 100644 html-test/ref/mini_IgnoreExports.html create mode 100644 html-test/ref/mini_ModuleWithWarning.html create mode 100644 html-test/ref/mini_NamedDoc.html create mode 100644 html-test/ref/mini_NoLayout.html create mode 100644 html-test/ref/mini_NonGreedy.html create mode 100644 html-test/ref/mini_Properties.html create mode 100644 html-test/ref/mini_PruneWithWarning.html create mode 100644 html-test/ref/mini_QuasiExpr.html create mode 100644 html-test/ref/mini_QuasiQuote.html create mode 100644 html-test/ref/mini_TH.html create mode 100644 html-test/ref/mini_TH2.html create mode 100644 html-test/ref/mini_Test.html create mode 100644 html-test/ref/mini_Ticket112.html create mode 100644 html-test/ref/mini_Ticket61.html create mode 100644 html-test/ref/mini_Ticket75.html create mode 100644 html-test/ref/mini_TypeFamilies.html create mode 100644 html-test/ref/mini_TypeOperators.html create mode 100644 html-test/ref/mini_Unicode.html create mode 100644 html-test/ref/mini_Visible.html (limited to 'html-test/ref') diff --git a/html-test/ref/A.html b/html-test/ref/A.html new file mode 100644 index 00000000..328fec02 --- /dev/null +++ b/html-test/ref/A.html @@ -0,0 +1,183 @@ + +A

 

Safe HaskellNone

A

Synopsis

Documentation

data A

Constructors

A 

other :: Int

test2 :: Bool

Doc for test2 +

data X

Should show up on the page for both modules A and B +

Constructors

X

Doc for consructor +

reExport :: Int

Should show up on the page for both modules A and B +

diff --git a/html-test/ref/AdvanceTypes.html b/html-test/ref/AdvanceTypes.html new file mode 100644 index 00000000..bac545be --- /dev/null +++ b/html-test/ref/AdvanceTypes.html @@ -0,0 +1,97 @@ + +AdvanceTypes

 

Safe HaskellNone

AdvanceTypes

Documentation

data Pattern where

Constructors

Nil :: Pattern `[]` 
Cons :: Maybe h -> Pattern t -> Pattern (h : t) 
diff --git a/html-test/ref/B.html b/html-test/ref/B.html new file mode 100644 index 00000000..410bc75b --- /dev/null +++ b/html-test/ref/B.html @@ -0,0 +1,175 @@ + +B

 

Safe HaskellNone

B

Synopsis

Documentation

module A

test :: Int

This link shouldn't work: other. + These links should work: other, sortBy, test2, test2, fromMaybe. + Module link: Prelude. +

reExport :: Int

Should show up on the page for both modules A and B +

data X

Should show up on the page for both modules A and B +

Constructors

X

Doc for consructor +

diff --git a/html-test/ref/Bug1.html b/html-test/ref/Bug1.html new file mode 100644 index 00000000..f8a86948 --- /dev/null +++ b/html-test/ref/Bug1.html @@ -0,0 +1,103 @@ + +Bug1

 

Safe HaskellNone

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

T 
diff --git a/html-test/ref/Bug2.html b/html-test/ref/Bug2.html new file mode 100644 index 00000000..813035a6 --- /dev/null +++ b/html-test/ref/Bug2.html @@ -0,0 +1,65 @@ + +Bug2

 

Safe HaskellNone

Bug2

Documentation

x :: A

diff --git a/html-test/ref/Bug3.html b/html-test/ref/Bug3.html new file mode 100644 index 00000000..76d4e730 --- /dev/null +++ b/html-test/ref/Bug3.html @@ -0,0 +1,83 @@ + +Bug3

 

Safe HaskellNone

Bug3

Synopsis

Documentation

foo :: Int

/multi-line + emphasis/ +

diff --git a/html-test/ref/Bug4.html b/html-test/ref/Bug4.html new file mode 100644 index 00000000..9e852978 --- /dev/null +++ b/html-test/ref/Bug4.html @@ -0,0 +1,82 @@ + +Bug4

 

Safe HaskellNone

Bug4

Synopsis

Documentation

foo :: Int

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

diff --git a/html-test/ref/Bug6.html b/html-test/ref/Bug6.html new file mode 100644 index 00000000..606e45e3 --- /dev/null +++ b/html-test/ref/Bug6.html @@ -0,0 +1,335 @@ + +Bug6

 

Safe HaskellNone

Bug6

Description

Exporting records. +

Synopsis

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 + (the field isn't documented separately since it is already documented here) +

Constructors

B 

Fields

b :: Int
 

data C

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

Constructors

C 

Fields

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 
diff --git a/html-test/ref/Bug7.html b/html-test/ref/Bug7.html new file mode 100644 index 00000000..8ac72b16 --- /dev/null +++ b/html-test/ref/Bug7.html @@ -0,0 +1,173 @@ + +Bug7

 

Safe HaskellNone

Bug7

Description

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

Synopsis

Documentation

data Foo

The Foo datatype +

Constructors

Foo 

Instances

Bar Foo Foo

Just one instance +

class Bar x y

The Bar class +

Instances

Bar Foo Foo

Just one instance +

diff --git a/html-test/ref/Bug8.html b/html-test/ref/Bug8.html new file mode 100644 index 00000000..469151f1 --- /dev/null +++ b/html-test/ref/Bug8.html @@ -0,0 +1,131 @@ + +Bug8

 

Safe HaskellNone

Bug8

Documentation

data Typ

Constructors

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

(-->) :: t -> t1 -> Typ

(--->) :: [a] -> Typ -> Typ

s :: a

t :: a

main :: a

diff --git a/html-test/ref/BugDeprecated.html b/html-test/ref/BugDeprecated.html new file mode 100644 index 00000000..913b189d --- /dev/null +++ b/html-test/ref/BugDeprecated.html @@ -0,0 +1,198 @@ + +BugDeprecated

 

Safe HaskellNone

BugDeprecated

Synopsis

Documentation

foo :: Int

Deprecated: for foo +

baz :: Int

Deprecated: for baz +

bar :: Int

Deprecated: for bar +

one :: Int

Deprecated: for one +

some documentation for one, two and three +

three :: Int

Deprecated: for three +

some documentation for one, two and three +

two :: Int

Deprecated: for two +

some documentation for one, two and three +

diff --git a/html-test/ref/BugExportHeadings.html b/html-test/ref/BugExportHeadings.html new file mode 100644 index 00000000..457e2c50 --- /dev/null +++ b/html-test/ref/BugExportHeadings.html @@ -0,0 +1,220 @@ + +BugExportHeadings

 

Safe HaskellNone

BugExportHeadings

Synopsis

Foo +

foo :: Int

Bar +

bar :: Int

Baz +

baz :: Int

One +

one :: Int

Deprecated: for one +

Two +

two :: Int

Deprecated: for two +

Three +

three :: Int

Deprecated: for three +

diff --git a/html-test/ref/Bugs.html b/html-test/ref/Bugs.html new file mode 100644 index 00000000..c5a4ca9d --- /dev/null +++ b/html-test/ref/Bugs.html @@ -0,0 +1,81 @@ + +Bugs

 

Safe HaskellNone

Bugs

Documentation

data A a

Constructors

A a (a -> Int) 
diff --git a/html-test/ref/CrossPackageDocs.html b/html-test/ref/CrossPackageDocs.html new file mode 100644 index 00000000..fea3d0cc --- /dev/null +++ b/html-test/ref/CrossPackageDocs.html @@ -0,0 +1,298 @@ + +CrossPackageDocs

 

Safe HaskellNone

CrossPackageDocs

Synopsis

Documentation

map :: (a -> b) -> [a] -> [b]

map f xs is the list obtained by applying f to each element + of xs, i.e., +

 map f [x1, x2, ..., xn] == [f x1, f x2, ..., f xn]
+ map f [x1, x2, ...] == [f x1, f x2, ...]
+

class IsString a where

Class for string-like datastructures; used by the overloaded string + extension (-foverloaded-strings in GHC). +

Methods

fromString :: String -> a

Instances

runInteractiveProcess

Arguments

:: FilePath

Filename of the executable (see proc for details) +

-> [String]

Arguments to pass to the executable +

-> Maybe FilePath

Optional path to the working directory +

-> Maybe [(String, String)]

Optional environment (otherwise inherit) +

-> IO (Handle, Handle, Handle, ProcessHandle) 

Runs a raw command, and returns Handles that may be used to communicate + with the process via its stdin, stdout and stderr respectively. +

For example, to start a process and feed a string to its stdin: +

   (inp,out,err,pid) <- runInteractiveProcess "..."
+   forkIO (hPutStr inp str)
+

The Handles are initially in binary mode; if you need them to be + in text mode then use hSetBinaryMode. +

diff --git a/html-test/ref/DeprecatedClass.html b/html-test/ref/DeprecatedClass.html new file mode 100644 index 00000000..d716c1d8 --- /dev/null +++ b/html-test/ref/DeprecatedClass.html @@ -0,0 +1,161 @@ + +DeprecatedClass

 

Safe HaskellNone

DeprecatedClass

Synopsis

Documentation

class SomeClass a where

Deprecated: SomeClass +

some class +

Methods

foo :: a -> a

Deprecated: foo +

documentation for foo +

class SomeOtherClass a where

Deprecated: SomeOtherClass +

Methods

bar :: a -> a

Deprecated: bar +

diff --git a/html-test/ref/DeprecatedData.html b/html-test/ref/DeprecatedData.html new file mode 100644 index 00000000..24758345 --- /dev/null +++ b/html-test/ref/DeprecatedData.html @@ -0,0 +1,198 @@ + +DeprecatedData

 

Safe HaskellNone

DeprecatedData

Synopsis

Documentation

data Foo

Deprecated: Foo +

type Foo +

Constructors

Foo

Deprecated: Foo +

constructor Foo +

Bar

Deprecated: Bar +

constructor Bar +

data One

Deprecated: One +

Constructors

One

Deprecated: One +

Two

Deprecated: Two +

diff --git a/html-test/ref/DeprecatedFunction.html b/html-test/ref/DeprecatedFunction.html new file mode 100644 index 00000000..1fc678bb --- /dev/null +++ b/html-test/ref/DeprecatedFunction.html @@ -0,0 +1,110 @@ + +DeprecatedFunction

 

Safe HaskellNone

DeprecatedFunction

Synopsis

Documentation

foo :: Int

Deprecated: use bar instead +

some documentation for foo +

bar :: Int

some documentation for bar +

diff --git a/html-test/ref/DeprecatedFunction2.html b/html-test/ref/DeprecatedFunction2.html new file mode 100644 index 00000000..b5068c8e --- /dev/null +++ b/html-test/ref/DeprecatedFunction2.html @@ -0,0 +1,84 @@ + +DeprecatedFunction2

 

Safe HaskellNone

DeprecatedFunction2

Synopsis

Documentation

foo :: Int

Deprecated: use bar instead +

diff --git a/html-test/ref/DeprecatedFunction3.html b/html-test/ref/DeprecatedFunction3.html new file mode 100644 index 00000000..f24eb666 --- /dev/null +++ b/html-test/ref/DeprecatedFunction3.html @@ -0,0 +1,84 @@ + +DeprecatedFunction3

 

Safe HaskellNone

DeprecatedFunction3

Synopsis

Documentation

foo :: Integer

Deprecated: use bar instead +

diff --git a/html-test/ref/DeprecatedModule.html b/html-test/ref/DeprecatedModule.html new file mode 100644 index 00000000..0ca4fafe --- /dev/null +++ b/html-test/ref/DeprecatedModule.html @@ -0,0 +1,83 @@ + +DeprecatedModule

 

Safe HaskellNone

DeprecatedModule

Description

Deprecated: Use Foo instead +

Documentation for DeprecatedModule. +

Documentation

foo :: Int

diff --git a/html-test/ref/DeprecatedModule2.html b/html-test/ref/DeprecatedModule2.html new file mode 100644 index 00000000..0a313ae9 --- /dev/null +++ b/html-test/ref/DeprecatedModule2.html @@ -0,0 +1,76 @@ + +DeprecatedModule2

 

Safe HaskellNone

DeprecatedModule2

Description

Deprecated: Use Foo instead +

Documentation

foo :: Int

diff --git a/html-test/ref/DeprecatedNewtype.html b/html-test/ref/DeprecatedNewtype.html new file mode 100644 index 00000000..521ffb92 --- /dev/null +++ b/html-test/ref/DeprecatedNewtype.html @@ -0,0 +1,161 @@ + +DeprecatedNewtype

 

Safe HaskellNone

DeprecatedNewtype

Documentation

newtype SomeNewType

Deprecated: SomeNewType +

some documentation +

Constructors

SomeNewTypeConst String

Deprecated: SomeNewTypeConst +

constructor docu +

newtype SomeOtherNewType

Deprecated: SomeOtherNewType +

Constructors

SomeOtherNewTypeConst String

Deprecated: SomeOtherNewTypeConst +

diff --git a/html-test/ref/DeprecatedReExport.html b/html-test/ref/DeprecatedReExport.html new file mode 100644 index 00000000..611c181d --- /dev/null +++ b/html-test/ref/DeprecatedReExport.html @@ -0,0 +1,133 @@ + +DeprecatedReExport

 

Safe HaskellNone

DeprecatedReExport

Description

What is tested here: +

  • Deprecation messages are shown for re-exported items. +

Synopsis

Re-exported from an other module +

foo :: Int

Deprecated: use bar instead +

some documentation for foo +

Re-exported from an other package +

Not yet working, see http://trac.haskell.org/haddock/ticket/223 + , isEmptyChan +

diff --git a/html-test/ref/DeprecatedRecord.html b/html-test/ref/DeprecatedRecord.html new file mode 100644 index 00000000..9ade8377 --- /dev/null +++ b/html-test/ref/DeprecatedRecord.html @@ -0,0 +1,151 @@ + +DeprecatedRecord

 

Safe HaskellNone

DeprecatedRecord

Synopsis

Documentation

data Foo

type Foo +

Constructors

Foo 

Fields

fooName :: String

some name +

fooValue :: Int

Deprecated: do not use this +

some value +

diff --git a/html-test/ref/DeprecatedTypeFamily.html b/html-test/ref/DeprecatedTypeFamily.html new file mode 100644 index 00000000..ffc069a6 --- /dev/null +++ b/html-test/ref/DeprecatedTypeFamily.html @@ -0,0 +1,108 @@ + +DeprecatedTypeFamily

 

Safe HaskellNone

DeprecatedTypeFamily

Synopsis

Documentation

data family SomeTypeFamily k :: * -> *

Deprecated: SomeTypeFamily +

some documentation +

data family SomeOtherTypeFamily k :: * -> *

Deprecated: SomeOtherTypeFamily +

diff --git a/html-test/ref/DeprecatedTypeSynonym.html b/html-test/ref/DeprecatedTypeSynonym.html new file mode 100644 index 00000000..665dcf5d --- /dev/null +++ b/html-test/ref/DeprecatedTypeSynonym.html @@ -0,0 +1,116 @@ + +DeprecatedTypeSynonym

 

Safe HaskellNone

DeprecatedTypeSynonym

Synopsis

Documentation

type TypeSyn = String

Deprecated: TypeSyn +

some documentation +

type OtherTypeSyn = String

Deprecated: OtherTypeSyn +

diff --git a/html-test/ref/DeprecationMessageParseError.html b/html-test/ref/DeprecationMessageParseError.html new file mode 100644 index 00000000..75f9bf54 --- /dev/null +++ b/html-test/ref/DeprecationMessageParseError.html @@ -0,0 +1,101 @@ + +DeprecationMessageParseError

 

Safe HaskellNone

DeprecationMessageParseError

Description

What is tested here: +

  • If parsing of a deprecation message fails, the message is included + verbatim. +

Synopsis

Documentation

foo :: Int

Deprecated: use @bar instead

some documentation for foo +

diff --git a/html-test/ref/Examples.html b/html-test/ref/Examples.html new file mode 100644 index 00000000..7ebe7770 --- /dev/null +++ b/html-test/ref/Examples.html @@ -0,0 +1,179 @@ + +Examples

 

Safe HaskellNone

Examples

Synopsis

Documentation

fib :: Integer -> Integer

Fibonacci number of given Integer. +

Examples: +

>>> fib 5
+5
+>>> fib 10
+55
+
>>> fib 10
+55
+

One more Example: +

>>> fib 5
+5
+

One more Example: +

>>> fib 5
+5
+

Example with an import: +

>>> import Data.Char
+>>> isSpace 'a'
+False
+
>>> putStrLn "foo\n\nbar"
+foo
+
+bar
+
diff --git a/html-test/ref/FunArgs.html b/html-test/ref/FunArgs.html new file mode 100644 index 00000000..6c87d1e6 --- /dev/null +++ b/html-test/ref/FunArgs.html @@ -0,0 +1,176 @@ + +FunArgs

 

Safe HaskellNone

FunArgs

Documentation

f

Arguments

:: forall a . Ord a 
=> Int

First argument +

-> a

Second argument +

-> Bool

Third argument +

-> (a -> a)

Fourth argument +

-> ()

Result +

g

Arguments

:: a

First argument +

-> b

Second argument +

-> c

Third argument +

-> d

Result +

diff --git a/html-test/ref/GADTRecords.html b/html-test/ref/GADTRecords.html new file mode 100644 index 00000000..e3fcd2fe --- /dev/null +++ b/html-test/ref/GADTRecords.html @@ -0,0 +1,234 @@ + +GADTRecords

 

Safe HaskellNone

GADTRecords

Synopsis

Documentation

data H1 a b where

h1 +

Constructors

C1 :: H1 a b 
C2 :: Ord a => [a] -> H1 a a 
C3 :: Int -> H1 Int Int 

Fields

field :: Int

hello docs +

C4 :: a -> H1 Int a 

Fields

field2 :: a

hello2 docs +

diff --git a/html-test/ref/Hash.html b/html-test/ref/Hash.html new file mode 100644 index 00000000..b0cd183c --- /dev/null +++ b/html-test/ref/Hash.html @@ -0,0 +1,337 @@ + +Hash

 

Safe HaskellNone

Hash

Description

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

Synopsis

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 +

Instances

Hash Float 
Hash Int 
(Hash a, Hash b) => Hash (a, b) 
diff --git a/html-test/ref/HiddenInstances.html b/html-test/ref/HiddenInstances.html new file mode 100644 index 00000000..999c114d --- /dev/null +++ b/html-test/ref/HiddenInstances.html @@ -0,0 +1,169 @@ + +HiddenInstances

 

Safe HaskellNone

HiddenInstances

Synopsis

Documentation

class VisibleClass a

Should be visible +

Instances

VisibleClass Int

Should be visible +

VisibleClass VisibleData

Should be visible +

data VisibleData

Should be visible +

Instances

Num VisibleData

Should be visible +

VisibleClass VisibleData

Should be visible +

diff --git a/html-test/ref/HiddenInstancesB.html b/html-test/ref/HiddenInstancesB.html new file mode 100644 index 00000000..207a5146 --- /dev/null +++ b/html-test/ref/HiddenInstancesB.html @@ -0,0 +1,143 @@ + +HiddenInstancesB

 

Safe HaskellNone

HiddenInstancesB

Synopsis

Documentation

class Foo a

Should be visible +

Instances

Foo Bar

Should be visible +

data Bar

Should be visible +

Instances

Foo Bar

Should be visible +

diff --git a/html-test/ref/Hyperlinks.html b/html-test/ref/Hyperlinks.html new file mode 100644 index 00000000..e7351a63 --- /dev/null +++ b/html-test/ref/Hyperlinks.html @@ -0,0 +1,89 @@ + +Hyperlinks

 

Safe HaskellNone

Hyperlinks

Synopsis

Documentation

foo :: Int

A plain URL: http://example.com/ +

A URL with a label: some link +

diff --git a/html-test/ref/IgnoreExports.html b/html-test/ref/IgnoreExports.html new file mode 100644 index 00000000..c661b48c --- /dev/null +++ b/html-test/ref/IgnoreExports.html @@ -0,0 +1,101 @@ + +IgnoreExports

 

Safe HaskellNone

IgnoreExports

Synopsis

Documentation

foo :: Int

documentation for foo +

bar :: Int

documentation for bar +

diff --git a/html-test/ref/ModuleWithWarning.html b/html-test/ref/ModuleWithWarning.html new file mode 100644 index 00000000..348f0822 --- /dev/null +++ b/html-test/ref/ModuleWithWarning.html @@ -0,0 +1,83 @@ + +ModuleWithWarning

 

Safe HaskellNone

ModuleWithWarning

Description

Warning: This is an unstable interface. Prefer functions from Prelude instead! +

Documentation for ModuleWithWarning. +

Documentation

foo :: Int

diff --git a/html-test/ref/NamedDoc.html b/html-test/ref/NamedDoc.html new file mode 100644 index 00000000..d2b8ede1 --- /dev/null +++ b/html-test/ref/NamedDoc.html @@ -0,0 +1,68 @@ + +NamedDoc

 

Safe HaskellNone

NamedDoc

Synopsis

    Documentation

    bar +

    diff --git a/html-test/ref/NoLayout.html b/html-test/ref/NoLayout.html new file mode 100644 index 00000000..871add05 --- /dev/null +++ b/html-test/ref/NoLayout.html @@ -0,0 +1,86 @@ + +NoLayout

     

    Safe HaskellNone

    NoLayout

    Synopsis

    Documentation

    g :: Int

    the function g +

    diff --git a/html-test/ref/NonGreedy.html b/html-test/ref/NonGreedy.html new file mode 100644 index 00000000..23d3f695 --- /dev/null +++ b/html-test/ref/NonGreedy.html @@ -0,0 +1,82 @@ + +NonGreedy

     

    Safe HaskellNone

    NonGreedy

    Synopsis

    • f :: a

    Documentation

    f :: a

    url1 url2 +

    diff --git a/html-test/ref/Properties.html b/html-test/ref/Properties.html new file mode 100644 index 00000000..1c4ce893 --- /dev/null +++ b/html-test/ref/Properties.html @@ -0,0 +1,92 @@ + +Properties

     

    Safe HaskellNone

    Properties

    Synopsis

    Documentation

    fib :: Integer -> Integer

    Fibonacci number of given Integer. +

    fib n <= fib (n + 1)
    diff --git a/html-test/ref/PruneWithWarning.html b/html-test/ref/PruneWithWarning.html new file mode 100644 index 00000000..3c31fbdf --- /dev/null +++ b/html-test/ref/PruneWithWarning.html @@ -0,0 +1,72 @@ + +PruneWithWarning

     

    Safe HaskellNone

    PruneWithWarning

    Description

    What is tested here: +

    • If a binding has a deprecation message but no documentation, it is pruned + when OPTIONS_HADDOCK prune is used. +
    diff --git a/html-test/ref/QuasiExpr.html b/html-test/ref/QuasiExpr.html new file mode 100644 index 00000000..0a699f35 --- /dev/null +++ b/html-test/ref/QuasiExpr.html @@ -0,0 +1,221 @@ + +QuasiExpr

     

    Safe HaskellNone

    QuasiExpr

    Documentation

    data Expr

    Constructors

    IntExpr Integer 
    AntiIntExpr String 
    BinopExpr BinOp Expr Expr 
    AntiExpr String 

    Instances

    data BinOp

    Constructors

    AddOp 
    SubOp 
    MulOp 
    DivOp 

    Instances

    eval :: Expr -> Integer

    expr :: QuasiQuoter

    parseExprExp :: String -> Q Exp

    diff --git a/html-test/ref/QuasiQuote.html b/html-test/ref/QuasiQuote.html new file mode 100644 index 00000000..f61f2b84 --- /dev/null +++ b/html-test/ref/QuasiQuote.html @@ -0,0 +1,65 @@ + +QuasiQuote

     

    Safe HaskellNone

    QuasiQuote

    Documentation

    val :: Integer

    diff --git a/html-test/ref/TH.html b/html-test/ref/TH.html new file mode 100644 index 00000000..086d6a4a --- /dev/null +++ b/html-test/ref/TH.html @@ -0,0 +1,63 @@ + +TH

     

    Safe HaskellNone

    TH

    Documentation

    decl :: Q [Dec]

    diff --git a/html-test/ref/TH2.html b/html-test/ref/TH2.html new file mode 100644 index 00000000..4d4a8914 --- /dev/null +++ b/html-test/ref/TH2.html @@ -0,0 +1,63 @@ + +TH2

     

    Safe HaskellNone

    TH2

    Documentation

    f :: t -> t

    diff --git a/html-test/ref/Test.html b/html-test/ref/Test.html new file mode 100644 index 00000000..f2ef2b28 --- /dev/null +++ b/html-test/ref/Test.html @@ -0,0 +1,2245 @@ + +Test

     

    Portabilityportable
    Stabilityprovisional
    Maintainerlibraries@haskell.org
    Safe HaskellNone

    Test

    Description

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

    Synopsis

    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

    N2 

    Fields

    n :: a b
     

    newtype N3 a b

    A newtype with a fieldname, documentation on the field +

    Constructors

    N3 

    Fields

    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 

    Fields

    n5 :: a b

    no docs on the datatype or the constructor +

    newtype N6 a b

    Constructors

    N6

    docs on the constructor only +

    Fields

    n6 :: a b
     

    newtype N7 a b

    docs on the newtype and the constructor +

    Constructors

    N7

    The N7 constructor +

    Fields

    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: +

    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: +

    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 +

    Fields

    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: +

    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)

    Instances

    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: +

    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) +
    1. This is an ordered list +
    2. This is the next item (different kind of bullet) +
    cat
    a small, furry, domesticated mammal +
    pineapple
    a fruit grown in the tropics +
    +     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 +

    k

    Arguments

    :: 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 +

    l

    Arguments

    :: (Int, Int, Float)

    takes a triple +

    -> Int

    returns an Int +

    m

    Arguments

    :: R 
    -> N1 ()

    one of the arguments +

    -> IO Int

    and the return value +

    This function has some arg docs +

    o

    Arguments

    :: 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\'' +

    withType :: Int

    Comment on a definition with type signature +

    withoutType :: a

    Comment on a definition without type signature +

    diff --git a/html-test/ref/Ticket112.html b/html-test/ref/Ticket112.html new file mode 100644 index 00000000..c5c61703 --- /dev/null +++ b/html-test/ref/Ticket112.html @@ -0,0 +1,82 @@ + +Ticket112

     

    Safe HaskellNone

    Ticket112

    Synopsis

    • f :: a

    Documentation

    f :: a

    ...given a raw Addr# to the string, and the length of the string. +

    diff --git a/html-test/ref/Ticket61.html b/html-test/ref/Ticket61.html new file mode 100644 index 00000000..8c22488b --- /dev/null +++ b/html-test/ref/Ticket61.html @@ -0,0 +1,80 @@ + +Ticket61

     

    Safe HaskellNone

    Ticket61

    Documentation

    class C a where

    Methods

    f :: a

    A comment about f +

    diff --git a/html-test/ref/Ticket75.html b/html-test/ref/Ticket75.html new file mode 100644 index 00000000..cd510ea5 --- /dev/null +++ b/html-test/ref/Ticket75.html @@ -0,0 +1,116 @@ + +Ticket75

     

    Safe HaskellNone

    Ticket75

    Synopsis

    Documentation

    data a :- b

    Constructors

    Q 

    f :: Int

    A reference to :- +

    diff --git a/html-test/ref/TypeFamilies.html b/html-test/ref/TypeFamilies.html new file mode 100644 index 00000000..196d60ec --- /dev/null +++ b/html-test/ref/TypeFamilies.html @@ -0,0 +1,212 @@ + +TypeFamilies

     

    Safe HaskellNone

    TypeFamilies

    Synopsis

    Documentation

    type family G a :: *

    Type family G +

    class A a where

    A class with an associated type +

    Associated Types

    data B a :: * -> *

    An associated type +

    Methods

    f :: B a Int

    A method +

    Instances

    A Int 

    type family F a

    Doc for family +

    g :: B Int Integer

    diff --git a/html-test/ref/TypeOperators.html b/html-test/ref/TypeOperators.html new file mode 100644 index 00000000..2b18727f --- /dev/null +++ b/html-test/ref/TypeOperators.html @@ -0,0 +1,185 @@ + +TypeOperators

     

    Safe HaskellNone

    TypeOperators

    Contents

    Synopsis

    • data a :-: b
    • data (a :+: b) c
    • data Op a b
    • newtype O g f a = O {}
    • biO :: (g `O` f) a

    stuff +

    data a :-: b

    data (a :+: b) c

    data Op a b

    newtype O g f a

    Constructors

    O 

    Fields

    unO :: g (f a)
     

    biO :: (g `O` f) a

    diff --git a/html-test/ref/Unicode.html b/html-test/ref/Unicode.html new file mode 100644 index 00000000..13ef6c1e --- /dev/null +++ b/html-test/ref/Unicode.html @@ -0,0 +1,82 @@ + +Unicode

     

    Safe HaskellNone

    Unicode

    Synopsis

    Documentation

    x :: Int

    γλώσσα +

    diff --git a/html-test/ref/Visible.html b/html-test/ref/Visible.html new file mode 100644 index 00000000..de8b8d80 --- /dev/null +++ b/html-test/ref/Visible.html @@ -0,0 +1,67 @@ + +Visible

     

    Safe HaskellNone

    Visible

    Documentation

    visible :: Int -> Int

    diff --git a/html-test/ref/frames.html b/html-test/ref/frames.html new file mode 100644 index 00000000..1b4e38d4 --- /dev/null +++ b/html-test/ref/frames.html @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + diff --git a/html-test/ref/mini_A.html b/html-test/ref/mini_A.html new file mode 100644 index 00000000..cbe50e41 --- /dev/null +++ b/html-test/ref/mini_A.html @@ -0,0 +1,59 @@ + +A

    A

    data A

    other

    test2

    data X

    reExport

    diff --git a/html-test/ref/mini_AdvanceTypes.html b/html-test/ref/mini_AdvanceTypes.html new file mode 100644 index 00000000..59d8dcb1 --- /dev/null +++ b/html-test/ref/mini_AdvanceTypes.html @@ -0,0 +1,33 @@ + +AdvanceTypes

    AdvanceTypes

    data Pattern

    diff --git a/html-test/ref/mini_B.html b/html-test/ref/mini_B.html new file mode 100644 index 00000000..211a7deb --- /dev/null +++ b/html-test/ref/mini_B.html @@ -0,0 +1,45 @@ + +B

    B

    test

    reExport

    data X

    diff --git a/html-test/ref/mini_Bug1.html b/html-test/ref/mini_Bug1.html new file mode 100644 index 00000000..adf81c73 --- /dev/null +++ b/html-test/ref/mini_Bug1.html @@ -0,0 +1,33 @@ + +Bug1

    Bug1

    data T

    diff --git a/html-test/ref/mini_Bug2.html b/html-test/ref/mini_Bug2.html new file mode 100644 index 00000000..b673e459 --- /dev/null +++ b/html-test/ref/mini_Bug2.html @@ -0,0 +1,31 @@ + +Bug2

    Bug2

    x

    diff --git a/html-test/ref/mini_Bug3.html b/html-test/ref/mini_Bug3.html new file mode 100644 index 00000000..af4cc445 --- /dev/null +++ b/html-test/ref/mini_Bug3.html @@ -0,0 +1,31 @@ + +Bug3

    Bug3

    foo

    diff --git a/html-test/ref/mini_Bug4.html b/html-test/ref/mini_Bug4.html new file mode 100644 index 00000000..b403e94a --- /dev/null +++ b/html-test/ref/mini_Bug4.html @@ -0,0 +1,31 @@ + +Bug4

    Bug4

    foo

    diff --git a/html-test/ref/mini_Bug6.html b/html-test/ref/mini_Bug6.html new file mode 100644 index 00000000..5c5c1119 --- /dev/null +++ b/html-test/ref/mini_Bug6.html @@ -0,0 +1,65 @@ + +Bug6

    Bug6

    data A

    data B

    data C

    data D

    data E

    diff --git a/html-test/ref/mini_Bug7.html b/html-test/ref/mini_Bug7.html new file mode 100644 index 00000000..1bec82ee --- /dev/null +++ b/html-test/ref/mini_Bug7.html @@ -0,0 +1,41 @@ + +Bug7

    Bug7

    data Foo

    class Bar x y

    diff --git a/html-test/ref/mini_Bug8.html b/html-test/ref/mini_Bug8.html new file mode 100644 index 00000000..070dbcf8 --- /dev/null +++ b/html-test/ref/mini_Bug8.html @@ -0,0 +1,63 @@ + +Bug8

    Bug8

    data Typ

    (-->)

    (--->)

    s

    t

    main

    diff --git a/html-test/ref/mini_BugDeprecated.html b/html-test/ref/mini_BugDeprecated.html new file mode 100644 index 00000000..f0410137 --- /dev/null +++ b/html-test/ref/mini_BugDeprecated.html @@ -0,0 +1,61 @@ + +BugDeprecated

    BugDeprecated

    foo

    baz

    bar

    one

    three

    two

    diff --git a/html-test/ref/mini_BugExportHeadings.html b/html-test/ref/mini_BugExportHeadings.html new file mode 100644 index 00000000..b481720d --- /dev/null +++ b/html-test/ref/mini_BugExportHeadings.html @@ -0,0 +1,79 @@ + +BugExportHeadings

    BugExportHeadings

    Foo +

    foo

    Bar +

    bar

    Baz +

    baz

    One +

    one

    Two +

    two

    Three +

    three

    diff --git a/html-test/ref/mini_Bugs.html b/html-test/ref/mini_Bugs.html new file mode 100644 index 00000000..3c758375 --- /dev/null +++ b/html-test/ref/mini_Bugs.html @@ -0,0 +1,33 @@ + +Bugs

    Bugs

    data A a

    diff --git a/html-test/ref/mini_CrossPackageDocs.html b/html-test/ref/mini_CrossPackageDocs.html new file mode 100644 index 00000000..4c0588ba --- /dev/null +++ b/html-test/ref/mini_CrossPackageDocs.html @@ -0,0 +1,45 @@ + +CrossPackageDocs

    CrossPackageDocs

    map

    class IsString a

    runInteractiveProcess

    diff --git a/html-test/ref/mini_DeprecatedClass.html b/html-test/ref/mini_DeprecatedClass.html new file mode 100644 index 00000000..3923c1ff --- /dev/null +++ b/html-test/ref/mini_DeprecatedClass.html @@ -0,0 +1,41 @@ + +DeprecatedClass

    DeprecatedClass

    class SomeClass a

    class SomeOtherClass a

    diff --git a/html-test/ref/mini_DeprecatedData.html b/html-test/ref/mini_DeprecatedData.html new file mode 100644 index 00000000..8ef20113 --- /dev/null +++ b/html-test/ref/mini_DeprecatedData.html @@ -0,0 +1,41 @@ + +DeprecatedData

    DeprecatedData

    data Foo

    data One

    diff --git a/html-test/ref/mini_DeprecatedFunction.html b/html-test/ref/mini_DeprecatedFunction.html new file mode 100644 index 00000000..9bb90dac --- /dev/null +++ b/html-test/ref/mini_DeprecatedFunction.html @@ -0,0 +1,37 @@ + +DeprecatedFunction

    DeprecatedFunction

    foo

    bar

    diff --git a/html-test/ref/mini_DeprecatedFunction2.html b/html-test/ref/mini_DeprecatedFunction2.html new file mode 100644 index 00000000..a03991a9 --- /dev/null +++ b/html-test/ref/mini_DeprecatedFunction2.html @@ -0,0 +1,31 @@ + +DeprecatedFunction2

    DeprecatedFunction2

    foo

    diff --git a/html-test/ref/mini_DeprecatedFunction3.html b/html-test/ref/mini_DeprecatedFunction3.html new file mode 100644 index 00000000..4ea60339 --- /dev/null +++ b/html-test/ref/mini_DeprecatedFunction3.html @@ -0,0 +1,31 @@ + +DeprecatedFunction3

    DeprecatedFunction3

    foo

    diff --git a/html-test/ref/mini_DeprecatedModule.html b/html-test/ref/mini_DeprecatedModule.html new file mode 100644 index 00000000..bfdef611 --- /dev/null +++ b/html-test/ref/mini_DeprecatedModule.html @@ -0,0 +1,31 @@ + +DeprecatedModule

    DeprecatedModule

    foo

    diff --git a/html-test/ref/mini_DeprecatedModule2.html b/html-test/ref/mini_DeprecatedModule2.html new file mode 100644 index 00000000..dbcc43b9 --- /dev/null +++ b/html-test/ref/mini_DeprecatedModule2.html @@ -0,0 +1,31 @@ + +DeprecatedModule2

    DeprecatedModule2

    foo

    diff --git a/html-test/ref/mini_DeprecatedNewtype.html b/html-test/ref/mini_DeprecatedNewtype.html new file mode 100644 index 00000000..a913525f --- /dev/null +++ b/html-test/ref/mini_DeprecatedNewtype.html @@ -0,0 +1,41 @@ + +DeprecatedNewtype

    DeprecatedNewtype

    data SomeNewType

    data SomeOtherNewType

    diff --git a/html-test/ref/mini_DeprecatedReExport.html b/html-test/ref/mini_DeprecatedReExport.html new file mode 100644 index 00000000..8316dda5 --- /dev/null +++ b/html-test/ref/mini_DeprecatedReExport.html @@ -0,0 +1,37 @@ + +DeprecatedReExport

    DeprecatedReExport

    Re-exported from an other module +

    foo

    Re-exported from an other package +

    diff --git a/html-test/ref/mini_DeprecatedRecord.html b/html-test/ref/mini_DeprecatedRecord.html new file mode 100644 index 00000000..3d949d2d --- /dev/null +++ b/html-test/ref/mini_DeprecatedRecord.html @@ -0,0 +1,33 @@ + +DeprecatedRecord

    DeprecatedRecord

    data Foo

    diff --git a/html-test/ref/mini_DeprecatedTypeFamily.html b/html-test/ref/mini_DeprecatedTypeFamily.html new file mode 100644 index 00000000..c87d9637 --- /dev/null +++ b/html-test/ref/mini_DeprecatedTypeFamily.html @@ -0,0 +1,41 @@ + +DeprecatedTypeFamily

    DeprecatedTypeFamily

    data family SomeTypeFamily k :: * -> *

    data family SomeOtherTypeFamily k :: * -> *

    diff --git a/html-test/ref/mini_DeprecatedTypeSynonym.html b/html-test/ref/mini_DeprecatedTypeSynonym.html new file mode 100644 index 00000000..5ade100d --- /dev/null +++ b/html-test/ref/mini_DeprecatedTypeSynonym.html @@ -0,0 +1,41 @@ + +DeprecatedTypeSynonym

    DeprecatedTypeSynonym

    type TypeSyn

    type OtherTypeSyn

    diff --git a/html-test/ref/mini_DeprecationMessageParseError.html b/html-test/ref/mini_DeprecationMessageParseError.html new file mode 100644 index 00000000..e52f487f --- /dev/null +++ b/html-test/ref/mini_DeprecationMessageParseError.html @@ -0,0 +1,31 @@ + +DeprecationMessageParseError

    DeprecationMessageParseError

    foo

    diff --git a/html-test/ref/mini_Examples.html b/html-test/ref/mini_Examples.html new file mode 100644 index 00000000..c99c2c48 --- /dev/null +++ b/html-test/ref/mini_Examples.html @@ -0,0 +1,31 @@ + +Examples

    Examples

    fib

    diff --git a/html-test/ref/mini_FunArgs.html b/html-test/ref/mini_FunArgs.html new file mode 100644 index 00000000..89729720 --- /dev/null +++ b/html-test/ref/mini_FunArgs.html @@ -0,0 +1,37 @@ + +FunArgs

    FunArgs

    f

    g

    diff --git a/html-test/ref/mini_GADTRecords.html b/html-test/ref/mini_GADTRecords.html new file mode 100644 index 00000000..a8b838f0 --- /dev/null +++ b/html-test/ref/mini_GADTRecords.html @@ -0,0 +1,33 @@ + +GADTRecords

    GADTRecords

    data H1 a b

    diff --git a/html-test/ref/mini_Hash.html b/html-test/ref/mini_Hash.html new file mode 100644 index 00000000..1e6ad1a9 --- /dev/null +++ b/html-test/ref/mini_Hash.html @@ -0,0 +1,74 @@ + +Hash

    Hash

    The HashTable type +

    data HashTable key val

    Operations on HashTables +

    new

    insert

    lookup

    The Hash class +

    class Hash a

    diff --git a/html-test/ref/mini_HiddenInstances.html b/html-test/ref/mini_HiddenInstances.html new file mode 100644 index 00000000..0f1a2e04 --- /dev/null +++ b/html-test/ref/mini_HiddenInstances.html @@ -0,0 +1,41 @@ + +HiddenInstances

    HiddenInstances

    class VisibleClass a

    data VisibleData

    diff --git a/html-test/ref/mini_HiddenInstancesB.html b/html-test/ref/mini_HiddenInstancesB.html new file mode 100644 index 00000000..3ce4f6a9 --- /dev/null +++ b/html-test/ref/mini_HiddenInstancesB.html @@ -0,0 +1,41 @@ + +HiddenInstancesB

    HiddenInstancesB

    class Foo a

    data Bar

    diff --git a/html-test/ref/mini_Hyperlinks.html b/html-test/ref/mini_Hyperlinks.html new file mode 100644 index 00000000..f0c7d65a --- /dev/null +++ b/html-test/ref/mini_Hyperlinks.html @@ -0,0 +1,31 @@ + +Hyperlinks

    Hyperlinks

    foo

    diff --git a/html-test/ref/mini_IgnoreExports.html b/html-test/ref/mini_IgnoreExports.html new file mode 100644 index 00000000..a420e65a --- /dev/null +++ b/html-test/ref/mini_IgnoreExports.html @@ -0,0 +1,37 @@ + +IgnoreExports

    IgnoreExports

    foo

    bar

    diff --git a/html-test/ref/mini_ModuleWithWarning.html b/html-test/ref/mini_ModuleWithWarning.html new file mode 100644 index 00000000..19315a14 --- /dev/null +++ b/html-test/ref/mini_ModuleWithWarning.html @@ -0,0 +1,31 @@ + +ModuleWithWarning

    ModuleWithWarning

    foo

    diff --git a/html-test/ref/mini_NamedDoc.html b/html-test/ref/mini_NamedDoc.html new file mode 100644 index 00000000..066bbc61 --- /dev/null +++ b/html-test/ref/mini_NamedDoc.html @@ -0,0 +1,25 @@ + +NamedDoc

    NamedDoc

    diff --git a/html-test/ref/mini_NoLayout.html b/html-test/ref/mini_NoLayout.html new file mode 100644 index 00000000..19562d70 --- /dev/null +++ b/html-test/ref/mini_NoLayout.html @@ -0,0 +1,31 @@ + +NoLayout

    NoLayout

    g

    diff --git a/html-test/ref/mini_NonGreedy.html b/html-test/ref/mini_NonGreedy.html new file mode 100644 index 00000000..698c368e --- /dev/null +++ b/html-test/ref/mini_NonGreedy.html @@ -0,0 +1,31 @@ + +NonGreedy

    NonGreedy

    f

    diff --git a/html-test/ref/mini_Properties.html b/html-test/ref/mini_Properties.html new file mode 100644 index 00000000..5f538dfd --- /dev/null +++ b/html-test/ref/mini_Properties.html @@ -0,0 +1,31 @@ + +Properties

    Properties

    fib

    diff --git a/html-test/ref/mini_PruneWithWarning.html b/html-test/ref/mini_PruneWithWarning.html new file mode 100644 index 00000000..9eb3aa00 --- /dev/null +++ b/html-test/ref/mini_PruneWithWarning.html @@ -0,0 +1,25 @@ + +PruneWithWarning

    PruneWithWarning

    diff --git a/html-test/ref/mini_QuasiExpr.html b/html-test/ref/mini_QuasiExpr.html new file mode 100644 index 00000000..7dd9b829 --- /dev/null +++ b/html-test/ref/mini_QuasiExpr.html @@ -0,0 +1,59 @@ + +QuasiExpr

    QuasiExpr

    data Expr

    data BinOp

    eval

    expr

    parseExprExp

    diff --git a/html-test/ref/mini_QuasiQuote.html b/html-test/ref/mini_QuasiQuote.html new file mode 100644 index 00000000..5dac6acc --- /dev/null +++ b/html-test/ref/mini_QuasiQuote.html @@ -0,0 +1,31 @@ + +QuasiQuote

    QuasiQuote

    val

    diff --git a/html-test/ref/mini_TH.html b/html-test/ref/mini_TH.html new file mode 100644 index 00000000..d2ddbabc --- /dev/null +++ b/html-test/ref/mini_TH.html @@ -0,0 +1,31 @@ + +TH

    TH

    decl

    diff --git a/html-test/ref/mini_TH2.html b/html-test/ref/mini_TH2.html new file mode 100644 index 00000000..2c9f1340 --- /dev/null +++ b/html-test/ref/mini_TH2.html @@ -0,0 +1,31 @@ + +TH2

    TH2

    f

    diff --git a/html-test/ref/mini_Test.html b/html-test/ref/mini_Test.html new file mode 100644 index 00000000..26db2c0f --- /dev/null +++ b/html-test/ref/mini_Test.html @@ -0,0 +1,269 @@ + +Test

    Test

    Type declarations +

    Data types +

    data T a b

    data T2 a b

    data T3 a b

    data T4 a b

    data T5 a b

    data T6

    data N1 a

    data N2 a b

    data N3 a b

    data N4 a b

    data N5 a b

    data N6 a b

    data N7 a b

    Records +

    data R

    data R1

    Class declarations +

    class C a

    class D a

    class E a

    class F a

    Function types +

    f

    Auxiliary stuff +

    A hidden module +

    hidden

    A visible module +

    Existential / Universal types +

    data Ex a

    Type signatures with argument docs +

    k

    l

    m

    A section +

    A subsection +

    f'

    withType

    withoutType

    diff --git a/html-test/ref/mini_Ticket112.html b/html-test/ref/mini_Ticket112.html new file mode 100644 index 00000000..68a0a5e5 --- /dev/null +++ b/html-test/ref/mini_Ticket112.html @@ -0,0 +1,31 @@ + +Ticket112

    Ticket112

    f

    diff --git a/html-test/ref/mini_Ticket61.html b/html-test/ref/mini_Ticket61.html new file mode 100644 index 00000000..a73fefca --- /dev/null +++ b/html-test/ref/mini_Ticket61.html @@ -0,0 +1,33 @@ + +Ticket61

    Ticket61

    class C a

    diff --git a/html-test/ref/mini_Ticket75.html b/html-test/ref/mini_Ticket75.html new file mode 100644 index 00000000..75ce882c --- /dev/null +++ b/html-test/ref/mini_Ticket75.html @@ -0,0 +1,39 @@ + +Ticket75

    Ticket75

    data a :- b

    f

    diff --git a/html-test/ref/mini_TypeFamilies.html b/html-test/ref/mini_TypeFamilies.html new file mode 100644 index 00000000..0cf39c88 --- /dev/null +++ b/html-test/ref/mini_TypeFamilies.html @@ -0,0 +1,55 @@ + +TypeFamilies

    TypeFamilies

    type family G a :: *

    class A a

    type family F a

    g

    diff --git a/html-test/ref/mini_TypeOperators.html b/html-test/ref/mini_TypeOperators.html new file mode 100644 index 00000000..86b6beec --- /dev/null +++ b/html-test/ref/mini_TypeOperators.html @@ -0,0 +1,66 @@ + +TypeOperators

    TypeOperators

    stuff +

    data a :-: b

    data (a :+: b) c

    data Op a b

    data O g f a

    biO

    diff --git a/html-test/ref/mini_Unicode.html b/html-test/ref/mini_Unicode.html new file mode 100644 index 00000000..55336980 --- /dev/null +++ b/html-test/ref/mini_Unicode.html @@ -0,0 +1,31 @@ + +Unicode

    Unicode

    x

    diff --git a/html-test/ref/mini_Visible.html b/html-test/ref/mini_Visible.html new file mode 100644 index 00000000..976a30c5 --- /dev/null +++ b/html-test/ref/mini_Visible.html @@ -0,0 +1,31 @@ + +Visible

    Visible

    visible

    -- cgit v1.2.3 From 8be6dc23701dcc1387fd56d61ad05df76a88f790 Mon Sep 17 00:00:00 2001 From: Simon Hengel Date: Mon, 15 Oct 2012 11:24:57 +0200 Subject: Copy css, images, etc. on accept --- html-test/accept.hs | 31 +-- html-test/ref/haddock-util.js | 344 ++++++++++++++++++++++++++ html-test/ref/hslogo-16.png | Bin 0 -> 1684 bytes html-test/ref/minus.gif | Bin 0 -> 56 bytes html-test/ref/ocean.css | 546 ++++++++++++++++++++++++++++++++++++++++++ html-test/ref/plus.gif | Bin 0 -> 59 bytes html-test/ref/synopsis.png | Bin 0 -> 11327 bytes 7 files changed, 906 insertions(+), 15 deletions(-) create mode 100644 html-test/ref/haddock-util.js create mode 100644 html-test/ref/hslogo-16.png create mode 100644 html-test/ref/minus.gif create mode 100644 html-test/ref/ocean.css create mode 100644 html-test/ref/plus.gif create mode 100644 html-test/ref/synopsis.png (limited to 'html-test/ref') diff --git a/html-test/accept.hs b/html-test/accept.hs index 82eb3c65..4722dbf9 100644 --- a/html-test/accept.hs +++ b/html-test/accept.hs @@ -1,38 +1,39 @@ import System.Cmd import System.Environment import System.FilePath -import System.Exit import System.Directory import Data.List -import Control.Monad import Control.Applicative - +main :: IO () main = do args <- getArgs dir <- getCurrentDirectory contents <- filter (`notElem` ignore) <$> getDirectoryContents (dir "output") - if not $ null args - then - mapM_ copy [ "output" file | file <- contents, ".html" `isSuffixOf` file, takeBaseName file `elem` args ] - else - mapM_ copy [ "output" file | file <- contents, ".html" `isSuffixOf` file ] + if not $ null args then + mapM_ copy [ "output" file | file <- contents, ".html" `isSuffixOf` file, takeBaseName file `elem` args ] + else + mapM_ copy [ "output" file | file <- contents] where ignore = [ - "doc-index.html" + "." + , ".." + , "doc-index.html" , "index-frames.html" , "index.html" ] - +copy :: FilePath -> IO () copy file = do let new = "ref" takeFileName file - print file - print new - contents <- readFile file - writeFile new (stripLinks contents) - + if ".html" `isSuffixOf` file then do + putStrLn (file ++ " -> " ++ new) + stripLinks <$> readFile file >>= writeFile new + else do + -- copy css, images, etc. + copyFile file new +stripLinks :: String -> String stripLinks str = let prefix = "= 0; +} + +function addClass(elem, value) { + var className = spaced(elem.className || ""); + if ( className.indexOf( " " + value + " " ) < 0 ) { + elem.className = trim(className + " " + value); + } +} + +function removeClass(elem, value) { + var className = spaced(elem.className || ""); + className = className.replace(" " + value + " ", " "); + elem.className = trim(className); +} + +function toggleClass(elem, valueOn, valueOff, bool) { + if (bool == null) { bool = ! hasClass(elem, valueOn); } + if (bool) { + removeClass(elem, valueOff); + addClass(elem, valueOn); + } + else { + removeClass(elem, valueOn); + addClass(elem, valueOff); + } + return bool; +} + + +function makeClassToggle(valueOn, valueOff) +{ + return function(elem, bool) { + return toggleClass(elem, valueOn, valueOff, bool); + } +} + +toggleShow = makeClassToggle("show", "hide"); +toggleCollapser = makeClassToggle("collapser", "expander"); + +function toggleSection(id) +{ + var b = toggleShow(document.getElementById("section." + id)); + toggleCollapser(document.getElementById("control." + id), b); + rememberCollapsed(id, b); + return b; +} + +var collapsed = {}; +function rememberCollapsed(id, b) +{ + if(b) + delete collapsed[id] + else + collapsed[id] = null; + + var sections = []; + for(var i in collapsed) + { + if(collapsed.hasOwnProperty(i)) + sections.push(i); + } + // cookie specific to this page; don't use setCookie which sets path=/ + document.cookie = "collapsed=" + escape(sections.join('+')); +} + +function restoreCollapsed() +{ + var cookie = getCookie("collapsed"); + if(!cookie) + return; + + var ids = cookie.split('+'); + for(var i in ids) + { + if(document.getElementById("section." + ids[i])) + toggleSection(ids[i]); + } +} + +function setCookie(name, value) { + document.cookie = name + "=" + escape(value) + ";path=/;"; +} + +function clearCookie(name) { + document.cookie = name + "=;path=/;expires=Thu, 01-Jan-1970 00:00:01 GMT;"; +} + +function getCookie(name) { + var nameEQ = name + "="; + var ca = document.cookie.split(';'); + for(var i=0;i < ca.length;i++) { + var c = ca[i]; + while (c.charAt(0)==' ') c = c.substring(1,c.length); + if (c.indexOf(nameEQ) == 0) { + return unescape(c.substring(nameEQ.length,c.length)); + } + } + return null; +} + + + +var max_results = 75; // 50 is not enough to search for map in the base libraries +var shown_range = null; +var last_search = null; + +function quick_search() +{ + perform_search(false); +} + +function full_search() +{ + perform_search(true); +} + + +function perform_search(full) +{ + var text = document.getElementById("searchbox").value.toLowerCase(); + if (text == last_search && !full) return; + last_search = text; + + var table = document.getElementById("indexlist"); + var status = document.getElementById("searchmsg"); + var children = table.firstChild.childNodes; + + // first figure out the first node with the prefix + var first = bisect(-1); + var last = (first == -1 ? -1 : bisect(1)); + + if (first == -1) + { + table.className = ""; + status.innerHTML = "No results found, displaying all"; + } + else if (first == 0 && last == children.length - 1) + { + table.className = ""; + status.innerHTML = ""; + } + else if (last - first >= max_results && !full) + { + table.className = ""; + status.innerHTML = "More than " + max_results + ", press Search to display"; + } + else + { + // decide what you need to clear/show + if (shown_range) + setclass(shown_range[0], shown_range[1], "indexrow"); + setclass(first, last, "indexshow"); + shown_range = [first, last]; + table.className = "indexsearch"; + status.innerHTML = ""; + } + + + function setclass(first, last, status) + { + for (var i = first; i <= last; i++) + { + children[i].className = status; + } + } + + + // do a binary search, treating 0 as ... + // return either -1 (no 0's found) or location of most far match + function bisect(dir) + { + var first = 0, finish = children.length - 1; + var mid, success = false; + + while (finish - first > 3) + { + mid = Math.floor((finish + first) / 2); + + var i = checkitem(mid); + if (i == 0) i = dir; + if (i == -1) + finish = mid; + else + first = mid; + } + var a = (dir == 1 ? first : finish); + var b = (dir == 1 ? finish : first); + for (var i = b; i != a - dir; i -= dir) + { + if (checkitem(i) == 0) return i; + } + return -1; + } + + + // from an index, decide what the result is + // 0 = match, -1 is lower, 1 is higher + function checkitem(i) + { + var s = getitem(i).toLowerCase().substr(0, text.length); + if (s == text) return 0; + else return (s > text ? -1 : 1); + } + + + // from an index, get its string + // this abstracts over alternates + function getitem(i) + { + for ( ; i >= 0; i--) + { + var s = children[i].firstChild.firstChild.data; + if (s.indexOf(' ') == -1) + return s; + } + return ""; // should never be reached + } +} + +function setSynopsis(filename) { + if (parent.window.synopsis) { + if (parent.window.synopsis.location.replace) { + // In Firefox this avoids adding the change to the history. + parent.window.synopsis.location.replace(filename); + } else { + parent.window.synopsis.location = filename; + } + } +} + +function addMenuItem(html) { + var menu = document.getElementById("page-menu"); + if (menu) { + var btn = menu.firstChild.cloneNode(false); + btn.innerHTML = html; + menu.appendChild(btn); + } +} + +function adjustForFrames() { + var bodyCls; + + if (parent.location.href == window.location.href) { + // not in frames, so add Frames button + addMenuItem("Frames"); + bodyCls = "no-frame"; + } + else { + bodyCls = "in-frame"; + } + addClass(document.body, bodyCls); +} + +function reframe() { + setCookie("haddock-reframe", document.URL); + window.location = "frames.html"; +} + +function postReframe() { + var s = getCookie("haddock-reframe"); + if (s) { + parent.window.main.location = s; + clearCookie("haddock-reframe"); + } +} + +function styles() { + var i, a, es = document.getElementsByTagName("link"), rs = []; + for (i = 0; a = es[i]; i++) { + if(a.rel.indexOf("style") != -1 && a.title) { + rs.push(a); + } + } + return rs; +} + +function addStyleMenu() { + var as = styles(); + var i, a, btns = ""; + for(i=0; a = as[i]; i++) { + btns += "
  • " + + a.title + "
    • " + } + if (as.length > 1) { + var h = "
    " + + "Style ▾" + + "
      " + btns + "
    " + + "
    "; + addMenuItem(h); + } +} + +function setActiveStyleSheet(title) { + var as = styles(); + var i, a, found; + for(i=0; a = as[i]; i++) { + a.disabled = true; + // need to do this always, some browsers are edge triggered + if(a.title == title) { + found = a; + } + } + if (found) { + found.disabled = false; + setCookie("haddock-style", title); + } + else { + as[0].disabled = false; + clearCookie("haddock-style"); + } + styleMenu(false); +} + +function resetStyle() { + var s = getCookie("haddock-style"); + if (s) setActiveStyleSheet(s); +} + + +function styleMenu(show) { + var m = document.getElementById('style-menu'); + if (m) toggleShow(m, show); +} + + +function pageLoad() { + addStyleMenu(); + adjustForFrames(); + resetStyle(); + restoreCollapsed(); +} + diff --git a/html-test/ref/hslogo-16.png b/html-test/ref/hslogo-16.png new file mode 100644 index 00000000..0ff8579f Binary files /dev/null and b/html-test/ref/hslogo-16.png differ diff --git a/html-test/ref/minus.gif b/html-test/ref/minus.gif new file mode 100644 index 00000000..1deac2fe Binary files /dev/null and b/html-test/ref/minus.gif differ diff --git a/html-test/ref/ocean.css b/html-test/ref/ocean.css new file mode 100644 index 00000000..42238709 --- /dev/null +++ b/html-test/ref/ocean.css @@ -0,0 +1,546 @@ +/* @group Fundamentals */ + +* { margin: 0; padding: 0 } + +/* Is this portable? */ +html { + background-color: white; + width: 100%; + height: 100%; +} + +body { + background: white; + color: black; + text-align: left; + min-height: 100%; + position: relative; +} + +p { + margin: 0.8em 0; +} + +ul, ol { + margin: 0.8em 0 0.8em 2em; +} + +dl { + margin: 0.8em 0; +} + +dt { + font-weight: bold; +} +dd { + margin-left: 2em; +} + +a { text-decoration: none; } +a[href]:link { color: rgb(196,69,29); } +a[href]:visited { color: rgb(171,105,84); } +a[href]:hover { text-decoration:underline; } + +/* @end */ + +/* @group Fonts & Sizes */ + +/* Basic technique & IE workarounds from YUI 3 + For reasons, see: + http://yui.yahooapis.com/3.1.1/build/cssfonts/fonts.css + */ + +body { + font:13px/1.4 sans-serif; + *font-size:small; /* for IE */ + *font:x-small; /* for IE in quirks mode */ +} + +h1 { font-size: 146.5%; /* 19pt */ } +h2 { font-size: 131%; /* 17pt */ } +h3 { font-size: 116%; /* 15pt */ } +h4 { font-size: 100%; /* 13pt */ } +h5 { font-size: 100%; /* 13pt */ } + +select, input, button, textarea { + font:99% sans-serif; +} + +table { + font-size:inherit; + font:100%; +} + +pre, code, kbd, samp, tt, .src { + font-family:monospace; + *font-size:108%; + line-height: 124%; +} + +.links, .link { + font-size: 85%; /* 11pt */ +} + +#module-header .caption { + font-size: 182%; /* 24pt */ +} + +.info { + font-size: 85%; /* 11pt */ +} + +#table-of-contents, #synopsis { + /* font-size: 85%; /* 11pt */ +} + + +/* @end */ + +/* @group Common */ + +.caption, h1, h2, h3, h4, h5, h6 { + font-weight: bold; + color: rgb(78,98,114); + margin: 0.8em 0 0.4em; +} + +* + h1, * + h2, * + h3, * + h4, * + h5, * + h6 { + margin-top: 2em; +} + +h1 + h2, h2 + h3, h3 + h4, h4 + h5, h5 + h6 { + margin-top: inherit; +} + +ul.links { + list-style: none; + text-align: left; + float: right; + display: inline-table; + margin: 0 0 0 1em; +} + +ul.links li { + display: inline; + border-left: 1px solid #d5d5d5; + white-space: nowrap; + padding: 0; +} + +ul.links li a { + padding: 0.2em 0.5em; +} + +.hide { display: none; } +.show { display: inherit; } +.clear { clear: both; } + +.collapser { + background-image: url(minus.gif); + background-repeat: no-repeat; +} +.expander { + background-image: url(plus.gif); + background-repeat: no-repeat; +} +p.caption.collapser, +p.caption.expander { + background-position: 0 0.4em; +} +.collapser, .expander { + padding-left: 14px; + margin-left: -14px; + cursor: pointer; +} + +pre { + padding: 0.25em; + margin: 0.8em 0; + background: rgb(229,237,244); + overflow: auto; + border-bottom: 0.25em solid white; + /* white border adds some space below the box to compensate + for visual extra space that paragraphs have between baseline + and the bounding box */ +} + +.src { + background: #f0f0f0; + padding: 0.2em 0.5em; +} + +.keyword { font-weight: normal; } +.def { font-weight: bold; } + + +/* @end */ + +/* @group Page Structure */ + +#content { + margin: 0 auto; + padding: 0 2em 6em; +} + +#package-header { + background: rgb(41,56,69); + border-top: 5px solid rgb(78,98,114); + color: #ddd; + padding: 0.2em; + position: relative; + text-align: left; +} + +#package-header .caption { + background: url(hslogo-16.png) no-repeat 0em; + color: white; + margin: 0 2em; + font-weight: normal; + font-style: normal; + padding-left: 2em; +} + +#package-header a:link, #package-header a:visited { color: white; } +#package-header a:hover { background: rgb(78,98,114); } + +#module-header .caption { + color: rgb(78,98,114); + font-weight: bold; + border-bottom: 1px solid #ddd; +} + +table.info { + float: right; + padding: 0.5em 1em; + border: 1px solid #ddd; + color: rgb(78,98,114); + background-color: #fff; + max-width: 40%; + border-spacing: 0; + position: relative; + top: -0.5em; + margin: 0 0 0 2em; +} + +.info th { + padding: 0 1em 0 0; +} + +div#style-menu-holder { + position: relative; + z-index: 2; + display: inline; +} + +#style-menu { + position: absolute; + z-index: 1; + overflow: visible; + background: #374c5e; + margin: 0; + text-align: center; + right: 0; + padding: 0; + top: 1.25em; +} + +#style-menu li { + display: list-item; + border-style: none; + margin: 0; + padding: 0; + color: #000; + list-style-type: none; +} + +#style-menu li + li { + border-top: 1px solid #919191; +} + +#style-menu a { + width: 6em; + padding: 3px; + display: block; +} + +#footer { + background: #ddd; + border-top: 1px solid #aaa; + padding: 0.5em 0; + color: #666; + text-align: center; + position: absolute; + bottom: 0; + width: 100%; + height: 3em; +} + +/* @end */ + +/* @group Front Matter */ + +#table-of-contents { + float: right; + clear: right; + background: #faf9dc; + border: 1px solid #d8d7ad; + padding: 0.5em 1em; + max-width: 20em; + margin: 0.5em 0 1em 1em; +} + +#table-of-contents .caption { + text-align: center; + margin: 0; +} + +#table-of-contents ul { + list-style: none; + margin: 0; +} + +#table-of-contents ul ul { + margin-left: 2em; +} + +#description .caption { + display: none; +} + +#synopsis { + display: none; +} + +.no-frame #synopsis { + display: block; + position: fixed; + right: 0; + height: 80%; + top: 10%; + padding: 0; +} + +#synopsis .caption { + float: left; + width: 29px; + color: rgba(255,255,255,0); + height: 110px; + margin: 0; + font-size: 1px; + padding: 0; +} + +#synopsis p.caption.collapser { + background: url(synopsis.png) no-repeat -64px -8px; +} + +#synopsis p.caption.expander { + background: url(synopsis.png) no-repeat 0px -8px; +} + +#synopsis ul { + height: 100%; + overflow: auto; + padding: 0.5em; + margin: 0; +} + +#synopsis ul ul { + overflow: hidden; +} + +#synopsis ul, +#synopsis ul li.src { + background-color: #faf9dc; + white-space: nowrap; + list-style: none; + margin-left: 0; +} + +/* @end */ + +/* @group Main Content */ + +#interface div.top { margin: 2em 0; } +#interface h1 + div.top, +#interface h2 + div.top, +#interface h3 + div.top, +#interface h4 + div.top, +#interface h5 + div.top { + margin-top: 1em; +} +#interface p.src .link { + float: right; + color: #919191; + border-left: 1px solid #919191; + background: #f0f0f0; + padding: 0 0.5em 0.2em; + margin: 0 -0.5em 0 0.5em; +} + +#interface table { border-spacing: 2px; } +#interface td { + vertical-align: top; + padding-left: 0.5em; +} +#interface td.src { + white-space: nowrap; +} +#interface td.doc p { + margin: 0; +} +#interface td.doc p + p { + margin-top: 0.8em; +} + +.subs dl { + margin: 0; +} + +.subs dt { + float: left; + clear: left; + display: block; + margin: 1px 0; +} + +.subs dd { + float: right; + width: 90%; + display: block; + padding-left: 0.5em; + margin-bottom: 0.5em; +} + +.subs dd.empty { + display: none; +} + +.subs dd p { + margin: 0; +} + +.top p.src { + border-top: 1px solid #ccc; +} + +.subs, .doc { + /* use this selector for one level of indent */ + padding-left: 2em; +} + +.warning { + color: red; +} + +.arguments { + margin-top: -0.4em; +} +.arguments .caption { + display: none; +} + +.fields { padding-left: 1em; } + +.fields .caption { display: none; } + +.fields p { margin: 0 0; } + +/* this seems bulky to me +.methods, .constructors { + background: #f8f8f8; + border: 1px solid #eee; +} +*/ + +/* @end */ + +/* @group Auxillary Pages */ + +#mini { + margin: 0 auto; + padding: 0 1em 1em; +} + +#mini > * { + font-size: 93%; /* 12pt */ +} + +#mini #module-list .caption, +#mini #module-header .caption { + font-size: 125%; /* 15pt */ +} + +#mini #interface h1, +#mini #interface h2, +#mini #interface h3, +#mini #interface h4 { + font-size: 109%; /* 13pt */ + margin: 1em 0 0; +} + +#mini #interface .top, +#mini #interface .src { + margin: 0; +} + +#mini #module-list ul { + list-style: none; + margin: 0; +} + +#alphabet ul { + list-style: none; + padding: 0; + margin: 0.5em 0 0; + text-align: center; +} + +#alphabet li { + display: inline; + margin: 0 0.25em; +} + +#alphabet a { + font-weight: bold; +} + +#index .caption, +#module-list .caption { font-size: 131%; /* 17pt */ } + +#index table { + margin-left: 2em; +} + +#index .src { + font-weight: bold; +} +#index .alt { + font-size: 77%; /* 10pt */ + font-style: italic; + padding-left: 2em; +} + +#index td + td { + padding-left: 1em; +} + +#module-list ul { + list-style: none; + margin: 0 0 0 2em; +} + +#module-list li { + clear: right; +} + +#module-list span.collapser, +#module-list span.expander { + background-position: 0 0.3em; +} + +#module-list .package { + float: right; +} + +/* @end */ diff --git a/html-test/ref/plus.gif b/html-test/ref/plus.gif new file mode 100644 index 00000000..2d15c141 Binary files /dev/null and b/html-test/ref/plus.gif differ diff --git a/html-test/ref/synopsis.png b/html-test/ref/synopsis.png new file mode 100644 index 00000000..85fb86ec Binary files /dev/null and b/html-test/ref/synopsis.png differ -- cgit v1.2.3 From 0007a5adc2460ec3bca4b86eda670a93bf91c3c3 Mon Sep 17 00:00:00 2001 From: Simon Hengel Date: Mon, 15 Oct 2012 20:03:43 +0200 Subject: Add test case for "spurious superclass constraints bug" --- html-test/ref/SpuriousSuperclassConstraints.html | 128 +++++++++++++++++++++ .../ref/mini_SpuriousSuperclassConstraints.html | 33 ++++++ html-test/tests/SpuriousSuperclassConstraints.hs | 30 +++++ 3 files changed, 191 insertions(+) create mode 100644 html-test/ref/SpuriousSuperclassConstraints.html create mode 100644 html-test/ref/mini_SpuriousSuperclassConstraints.html create mode 100644 html-test/tests/SpuriousSuperclassConstraints.hs (limited to 'html-test/ref') diff --git a/html-test/ref/SpuriousSuperclassConstraints.html b/html-test/ref/SpuriousSuperclassConstraints.html new file mode 100644 index 00000000..26b30d24 --- /dev/null +++ b/html-test/ref/SpuriousSuperclassConstraints.html @@ -0,0 +1,128 @@ + +SpuriousSuperclassConstraints
    Safe HaskellNone

    SpuriousSuperclassConstraints

    Description

    What is tested here: +

    Due to a change in GHC 7.6.1 we had a bug that superclass contraints were + included in the instances list. Edward K. repported it here: +

    http://www.haskell.org/pipermail/haskell-cafe/2012-September/103600.html +

    And here is the corresponding theard on glasgow-haskell-users: +

    http://www.haskell.org/pipermail/glasgow-haskell-users/2012-September/022914.html +

    It has been fixed in: +

     6ccf78e15a525282fef61bc4f58a279aa9c21771
+ Fix spurious superclass constraints bug.
+

    Documentation

    data SomeType f a

    Instances

    diff --git a/html-test/ref/mini_SpuriousSuperclassConstraints.html b/html-test/ref/mini_SpuriousSuperclassConstraints.html new file mode 100644 index 00000000..22079a4e --- /dev/null +++ b/html-test/ref/mini_SpuriousSuperclassConstraints.html @@ -0,0 +1,33 @@ + +SpuriousSuperclassConstraints

    SpuriousSuperclassConstraints

    data SomeType f a

    diff --git a/html-test/tests/SpuriousSuperclassConstraints.hs b/html-test/tests/SpuriousSuperclassConstraints.hs new file mode 100644 index 00000000..d9e43e1c --- /dev/null +++ b/html-test/tests/SpuriousSuperclassConstraints.hs @@ -0,0 +1,30 @@ +{-# LANGUAGE EmptyDataDecls, KindSignatures #-} +-- | +-- What is tested here: +-- +-- Due to a change in GHC 7.6.1 we had a bug that superclass contraints were +-- included in the instances list. Edward K. repported it here: +-- +-- +-- +-- And here is the corresponding theard on glasgow-haskell-users: +-- +-- +-- +-- It has been fixed in: +-- +-- > 6ccf78e15a525282fef61bc4f58a279aa9c21771 +-- > Fix spurious superclass constraints bug. +-- +module SpuriousSuperclassConstraints where + +import Control.Applicative + +data SomeType (f :: * -> *) a + +instance Functor (SomeType f) where + fmap = undefined + +instance Applicative f => Applicative (SomeType f) where + pure = undefined + (<*>) = undefined -- cgit v1.2.3 From e2c75d48f4dfd4140e977d097a95aa06b614fa24 Mon Sep 17 00:00:00 2001 From: Simon Hengel Date: Fri, 7 Dec 2012 19:52:58 +0100 Subject: Bump version --- doc/haddock.xml | 2 +- haddock.cabal | 2 +- haddock.spec | 2 +- html-test/ref/A.html | 2 +- html-test/ref/AdvanceTypes.html | 2 +- html-test/ref/B.html | 2 +- html-test/ref/Bug1.html | 2 +- html-test/ref/Bug2.html | 2 +- html-test/ref/Bug3.html | 2 +- html-test/ref/Bug4.html | 2 +- html-test/ref/Bug6.html | 2 +- html-test/ref/Bug7.html | 2 +- html-test/ref/Bug8.html | 2 +- html-test/ref/BugDeprecated.html | 2 +- html-test/ref/BugExportHeadings.html | 2 +- html-test/ref/Bugs.html | 2 +- html-test/ref/CrossPackageDocs.html | 2 +- html-test/ref/DeprecatedClass.html | 2 +- html-test/ref/DeprecatedData.html | 2 +- html-test/ref/DeprecatedFunction.html | 2 +- html-test/ref/DeprecatedFunction2.html | 2 +- html-test/ref/DeprecatedFunction3.html | 2 +- html-test/ref/DeprecatedModule.html | 2 +- html-test/ref/DeprecatedModule2.html | 2 +- html-test/ref/DeprecatedNewtype.html | 2 +- html-test/ref/DeprecatedReExport.html | 2 +- html-test/ref/DeprecatedRecord.html | 2 +- html-test/ref/DeprecatedTypeFamily.html | 2 +- html-test/ref/DeprecatedTypeSynonym.html | 2 +- html-test/ref/DeprecationMessageParseError.html | 2 +- html-test/ref/Examples.html | 2 +- html-test/ref/FunArgs.html | 2 +- html-test/ref/GADTRecords.html | 2 +- html-test/ref/Hash.html | 2 +- html-test/ref/HiddenInstances.html | 2 +- html-test/ref/HiddenInstancesB.html | 2 +- html-test/ref/Hyperlinks.html | 2 +- html-test/ref/IgnoreExports.html | 2 +- html-test/ref/ModuleWithWarning.html | 2 +- html-test/ref/NamedDoc.html | 2 +- html-test/ref/NoLayout.html | 2 +- html-test/ref/NonGreedy.html | 2 +- html-test/ref/Properties.html | 2 +- html-test/ref/PruneWithWarning.html | 2 +- html-test/ref/QuasiExpr.html | 2 +- html-test/ref/QuasiQuote.html | 2 +- html-test/ref/SpuriousSuperclassConstraints.html | 2 +- html-test/ref/TH.html | 2 +- html-test/ref/TH2.html | 2 +- html-test/ref/Test.html | 2 +- html-test/ref/Ticket112.html | 2 +- html-test/ref/Ticket61.html | 2 +- html-test/ref/Ticket75.html | 2 +- html-test/ref/TypeFamilies.html | 2 +- html-test/ref/TypeOperators.html | 2 +- html-test/ref/Unicode.html | 2 +- html-test/ref/Visible.html | 2 +- 57 files changed, 57 insertions(+), 57 deletions(-) (limited to 'html-test/ref') diff --git a/doc/haddock.xml b/doc/haddock.xml index 4e4447dc..139b2830 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -21,7 +21,7 @@ Simon Marlow, David Waern - This document describes Haddock version 2.13.1, a Haskell + This document describes Haddock version 2.13.2, a Haskell documentation tool. diff --git a/haddock.cabal b/haddock.cabal index 99bf5e4a..06a85364 100644 --- a/haddock.cabal +++ b/haddock.cabal @@ -1,5 +1,5 @@ name: haddock -version: 2.13.1 +version: 2.13.2 synopsis: A documentation-generation tool for Haskell libraries description: Haddock is a documentation-generation tool for Haskell libraries diff --git a/haddock.spec b/haddock.spec index 401f1e8a..9d6ea8f6 100644 --- a/haddock.spec +++ b/haddock.spec @@ -17,7 +17,7 @@ # version label of your release tarball. %define name haddock -%define version 2.13.1 +%define version 2.13.2 %define release 1 Name: %{name} diff --git a/html-test/ref/A.html b/html-test/ref/A.html index 328fec02..9a60933e 100644 --- a/html-test/ref/A.html +++ b/html-test/ref/A.html @@ -176,7 +176,7 @@ window.onload = function () {pageLoad();setSynopsis("mini_A.html");}; >

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2

    Produced by Haddock version 2.13.1

    version 2.13.2