From 2448bd71609688be7b8bfe362a8534959531cd79 Mon Sep 17 00:00:00 2001
From: Simon Hengel
A constructor -
constructorAn abstract data declaration -
An abstract data declarationA data declaration with no documentation annotations on the constructors -
A data declaration with no documentation annotations on the constructorsA3 -
Testing alternative comment styles -
Testing alternative comment stylesA4 -
A newtype -
A newtypea b
A newtype with a fieldname -
A newtype with a fieldnamea b
A newtype with a fieldname, documentation on the field -
A newtype with a fieldname, documentation on the fieldn3 field -
fieldAn abstract newtype - we show this one as data rather than newtype because - the difference isn't visible to the programmer for an abstract type. -
no docs on the datatype or the constructor -
no docs on the datatype or the constructordocs on the constructor only -
docs on the constructor onlydocs on the newtype and the constructor -
docs on the newtype and the constructorN7 constructor -
constructorC1 record constructor, with the following fields: -
record constructor, with the following fields:Testing different record commenting styles -
Testing different record commenting stylesC3 record constructor -
record constructortest that we can export record selectors on their own: -
test that we can export record selectors on their own:a method -
methodb method -
methodThis is a class declaration with no separate docs for the methods -
This is a class declaration with no separate docs for the methodsa
This is a class declaration with no methods (or no methods exported) -
This is a class declaration with no methods (or no methods exported)Test that we can export a class method on its own: -
Test that we can export a class method on its own:
- This is a block of code, which can include other markup: This is a block of code, which can include other markup: R
this is another block of code
-
this is another block of code
We can also include URLs in documentation: http://www.haskell.org/. -
.we can export foreign declarations too -
we can export foreign declarations tooThis 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) -
This is some documentation that is attached to a name ($aux2)a nested, named doc comment -
a nested, named doc commentwith a paragraph, -
with a paragraph,and a code block
test -test1 -
test2 test3 @@ -1781,70 +1731,57 @@ test1 >
-test1 + >test1 test2
test3 -test4 -
-test1 + >test1 test2
test3 -test4 -
test3 -test4 -
-test1 + >test1 test2
aux11: -
aux11:test3 -test4 -
-test1 + >test1 test2
foo -foo
bar -bar
This is some inline documentation in the export list -
This is some inline documentation in the export lista code block using bird-tracks each line must begin with > (which isn't significant unless it - is at the beginning of the line). -
nested-style doc comments -
nested-style doc commentsA data-type using existential/universal types -
A data-type using existential/universal typesT -
This argument has type 'T2 Int Int' -
This argument has type 'T2 Int Int'This argument has type T3 Bool Bool -> T4 Float Float
-
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. -
This is the result type -
This is the result typeThis is a function with documentation for each argument -
This is a function with documentation for each argumenttakes a triple -
takes a tripleone of the arguments -
one of the argumentsand the return value -
and the return valueThis function has some arg docs -
This function has some arg docsThe input float -
The input floatThe output float -
The output floatA foreign import with argument docs -
A foreign import with argument docsa literal line -a literal line
$ a non literal line $ -
line $f' - but f' doesn't get link'd 'f\'' -
Comment on a definition with type signature -
Comment on a definition with type signatureComment on a definition without type signature -
Comment on a definition without type signature