<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html> <head> <!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ --> <title>src/Haddock/Doc.hs</title> <link type='text/css' rel='stylesheet' href='hscolour.css' /> </head> <body> <pre><a name="line-1"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Doc</span> <span class='hs-layout'>(</span> <a name="line-2"></a> <span class='hs-varid'>docAppend</span><span class='hs-layout'>,</span> <a name="line-3"></a> <span class='hs-varid'>docParagraph</span> <a name="line-4"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-5"></a> <a name="line-6"></a> <a name="line-7"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span> <a name="line-8"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Char</span> <span class='hs-layout'>(</span><span class='hs-varid'>isSpace</span><span class='hs-layout'>)</span> <a name="line-9"></a> <a name="line-10"></a> <a name="line-11"></a><a name="docAppend"></a><span class='hs-comment'>-- used to make parsing easier; we group the list items later</span> <a name="line-12"></a><span class='hs-definition'>docAppend</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span> <a name="line-13"></a><span class='hs-definition'>docAppend</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocUnorderedList</span> <span class='hs-varid'>ds1</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocUnorderedList</span> <span class='hs-varid'>ds2</span><span class='hs-layout'>)</span> <a name="line-14"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DocUnorderedList</span> <span class='hs-layout'>(</span><span class='hs-varid'>ds1</span><span class='hs-varop'>++</span><span class='hs-varid'>ds2</span><span class='hs-layout'>)</span> <a name="line-15"></a><span class='hs-definition'>docAppend</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocUnorderedList</span> <span class='hs-varid'>ds1</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocAppend</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocUnorderedList</span> <span class='hs-varid'>ds2</span><span class='hs-layout'>)</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span> <a name="line-16"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DocAppend</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocUnorderedList</span> <span class='hs-layout'>(</span><span class='hs-varid'>ds1</span><span class='hs-varop'>++</span><span class='hs-varid'>ds2</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>d</span> <a name="line-17"></a><span class='hs-definition'>docAppend</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocOrderedList</span> <span class='hs-varid'>ds1</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocOrderedList</span> <span class='hs-varid'>ds2</span><span class='hs-layout'>)</span> <a name="line-18"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DocOrderedList</span> <span class='hs-layout'>(</span><span class='hs-varid'>ds1</span><span class='hs-varop'>++</span><span class='hs-varid'>ds2</span><span class='hs-layout'>)</span> <a name="line-19"></a><span class='hs-definition'>docAppend</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocOrderedList</span> <span class='hs-varid'>ds1</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocAppend</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocOrderedList</span> <span class='hs-varid'>ds2</span><span class='hs-layout'>)</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span> <a name="line-20"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DocAppend</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocOrderedList</span> <span class='hs-layout'>(</span><span class='hs-varid'>ds1</span><span class='hs-varop'>++</span><span class='hs-varid'>ds2</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>d</span> <a name="line-21"></a><span class='hs-definition'>docAppend</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocDefList</span> <span class='hs-varid'>ds1</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocDefList</span> <span class='hs-varid'>ds2</span><span class='hs-layout'>)</span> <a name="line-22"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DocDefList</span> <span class='hs-layout'>(</span><span class='hs-varid'>ds1</span><span class='hs-varop'>++</span><span class='hs-varid'>ds2</span><span class='hs-layout'>)</span> <a name="line-23"></a><span class='hs-definition'>docAppend</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocDefList</span> <span class='hs-varid'>ds1</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocAppend</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocDefList</span> <span class='hs-varid'>ds2</span><span class='hs-layout'>)</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span> <a name="line-24"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DocAppend</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocDefList</span> <span class='hs-layout'>(</span><span class='hs-varid'>ds1</span><span class='hs-varop'>++</span><span class='hs-varid'>ds2</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>d</span> <a name="line-25"></a><span class='hs-definition'>docAppend</span> <span class='hs-conid'>DocEmpty</span> <span class='hs-varid'>d</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>d</span> <a name="line-26"></a><span class='hs-definition'>docAppend</span> <span class='hs-varid'>d</span> <span class='hs-conid'>DocEmpty</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>d</span> <a name="line-27"></a><span class='hs-definition'>docAppend</span> <span class='hs-varid'>d1</span> <span class='hs-varid'>d2</span> <a name="line-28"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DocAppend</span> <span class='hs-varid'>d1</span> <span class='hs-varid'>d2</span> <a name="line-29"></a> <a name="line-30"></a><a name="docParagraph"></a><span class='hs-comment'>-- again to make parsing easier - we spot a paragraph whose only item</span> <a name="line-31"></a><span class='hs-comment'>-- is a DocMonospaced and make it into a DocCodeBlock</span> <a name="line-32"></a><span class='hs-definition'>docParagraph</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span> <a name="line-33"></a><span class='hs-definition'>docParagraph</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocMonospaced</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span> <a name="line-34"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DocCodeBlock</span> <span class='hs-layout'>(</span><span class='hs-varid'>docCodeBlock</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span> <a name="line-35"></a><span class='hs-definition'>docParagraph</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocAppend</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocString</span> <span class='hs-varid'>s1</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocMonospaced</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-36"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>all</span> <span class='hs-varid'>isSpace</span> <span class='hs-varid'>s1</span> <a name="line-37"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DocCodeBlock</span> <span class='hs-layout'>(</span><span class='hs-varid'>docCodeBlock</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span> <a name="line-38"></a><span class='hs-definition'>docParagraph</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocAppend</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocString</span> <span class='hs-varid'>s1</span><span class='hs-layout'>)</span> <a name="line-39"></a> <span class='hs-layout'>(</span><span class='hs-conid'>DocAppend</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocMonospaced</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocString</span> <span class='hs-varid'>s2</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-40"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>all</span> <span class='hs-varid'>isSpace</span> <span class='hs-varid'>s1</span> <span class='hs-varop'>&&</span> <span class='hs-varid'>all</span> <span class='hs-varid'>isSpace</span> <span class='hs-varid'>s2</span> <a name="line-41"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DocCodeBlock</span> <span class='hs-layout'>(</span><span class='hs-varid'>docCodeBlock</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span> <a name="line-42"></a><span class='hs-definition'>docParagraph</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocAppend</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocMonospaced</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocString</span> <span class='hs-varid'>s2</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-43"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>all</span> <span class='hs-varid'>isSpace</span> <span class='hs-varid'>s2</span> <a name="line-44"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DocCodeBlock</span> <span class='hs-layout'>(</span><span class='hs-varid'>docCodeBlock</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span> <a name="line-45"></a><span class='hs-definition'>docParagraph</span> <span class='hs-varid'>p</span> <a name="line-46"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DocParagraph</span> <span class='hs-varid'>p</span> <a name="line-47"></a> <a name="line-48"></a> <a name="line-49"></a><a name="docCodeBlock"></a><span class='hs-comment'>-- Drop trailing whitespace from @..@ code blocks. Otherwise this:</span> <a name="line-50"></a><span class='hs-comment'>--</span> <a name="line-51"></a><span class='hs-comment'>-- -- @</span> <a name="line-52"></a><span class='hs-comment'>-- -- foo</span> <a name="line-53"></a><span class='hs-comment'>-- -- @</span> <a name="line-54"></a><span class='hs-comment'>--</span> <a name="line-55"></a><span class='hs-comment'>-- turns into (DocCodeBlock "\nfoo\n ") which when rendered in HTML</span> <a name="line-56"></a><span class='hs-comment'>-- gives an extra vertical space after the code block. The single space</span> <a name="line-57"></a><span class='hs-comment'>-- on the final line seems to trigger the extra vertical space.</span> <a name="line-58"></a><span class='hs-comment'>--</span> <a name="line-59"></a><span class='hs-definition'>docCodeBlock</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Doc</span> <span class='hs-varid'>id</span> <a name="line-60"></a><span class='hs-definition'>docCodeBlock</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocString</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span> <a name="line-61"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DocString</span> <span class='hs-layout'>(</span><span class='hs-varid'>reverse</span> <span class='hs-varop'>$</span> <span class='hs-varid'>dropWhile</span> <span class='hs-layout'>(</span><span class='hs-varop'>`elem`</span> <span class='hs-str'>" \t"</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-varid'>reverse</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span> <a name="line-62"></a><span class='hs-definition'>docCodeBlock</span> <span class='hs-layout'>(</span><span class='hs-conid'>DocAppend</span> <span class='hs-varid'>l</span> <span class='hs-varid'>r</span><span class='hs-layout'>)</span> <a name="line-63"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DocAppend</span> <span class='hs-varid'>l</span> <span class='hs-layout'>(</span><span class='hs-varid'>docCodeBlock</span> <span class='hs-varid'>r</span><span class='hs-layout'>)</span> <a name="line-64"></a><span class='hs-definition'>docCodeBlock</span> <span class='hs-varid'>d</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>d</span> </pre></body> </html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
33ad064c4b642ed30353356a1d094330
>
files
>
90
