diff options
| -rw-r--r-- | examples/Foo.hs | 25 | ||||
| -rw-r--r-- | examples/Hidden.hs | 3 | ||||
| -rw-r--r-- | examples/Visible.hs | 2 |
3 files changed, 30 insertions, 0 deletions
diff --git a/examples/Foo.hs b/examples/Foo.hs index 5837fab9..78b2e053 100644 --- a/examples/Foo.hs +++ b/examples/Foo.hs @@ -38,6 +38,22 @@ module Foo ( -- $aux1 -- $aux2 + + -- $aux3 + + -- $aux4 + + -- | 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, ) where @@ -144,5 +160,14 @@ 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) ] diff --git a/examples/Hidden.hs b/examples/Hidden.hs new file mode 100644 index 00000000..dce05043 --- /dev/null +++ b/examples/Hidden.hs @@ -0,0 +1,3 @@ +-- #hide +module Hidden where +hidden :: Int -> Int diff --git a/examples/Visible.hs b/examples/Visible.hs new file mode 100644 index 00000000..33987c46 --- /dev/null +++ b/examples/Visible.hs @@ -0,0 +1,2 @@ +module Visible where +visible :: Int -> Int |