<?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/Interface/ExtractFnArgDocs.hs</title> <link type='text/css' rel='stylesheet' href='hscolour.css' /> </head> <body> <pre><a name="line-1"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span> <a name="line-2"></a><span class='hs-comment'>-- |</span> <a name="line-3"></a><span class='hs-comment'>-- Module : Haddock.Interface.ExtractFnArgDocs</span> <a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) Isaac Dupree 2009,</span> <a name="line-5"></a><span class='hs-comment'>-- License : BSD-like</span> <a name="line-6"></a><span class='hs-comment'>--</span> <a name="line-7"></a><span class='hs-comment'>-- Maintainer : haddock@projects.haskell.org</span> <a name="line-8"></a><span class='hs-comment'>-- Stability : experimental</span> <a name="line-9"></a><span class='hs-comment'>-- Portability : portable</span> <a name="line-10"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span> <a name="line-11"></a> <a name="line-12"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Interface</span><span class='hs-varop'>.</span><span class='hs-conid'>ExtractFnArgDocs</span> <span class='hs-layout'>(</span> <a name="line-13"></a> <span class='hs-varid'>getDeclFnArgDocs</span><span class='hs-layout'>,</span> <span class='hs-varid'>getSigFnArgDocs</span><span class='hs-layout'>,</span> <span class='hs-varid'>getTypeFnArgDocs</span> <a name="line-14"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-15"></a> <a name="line-16"></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-17"></a> <a name="line-18"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Map</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Map</span> <a name="line-19"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Map</span> <span class='hs-layout'>(</span><span class='hs-conid'>Map</span><span class='hs-layout'>)</span> <a name="line-20"></a> <a name="line-21"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>GHC</span> <a name="line-22"></a> <a name="line-23"></a><span class='hs-comment'>-- the type of Name doesn't matter, except in 6.10 where</span> <a name="line-24"></a><span class='hs-comment'>-- HsDocString = HsDoc Name, so we can't just say "HsDecl name" yet.</span> <a name="line-25"></a> <a name="line-26"></a><a name="getDeclFnArgDocs"></a><span class='hs-definition'>getDeclFnArgDocs</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>HsDecl</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Int</span> <span class='hs-conid'>HsDocString</span> <a name="line-27"></a><span class='hs-definition'>getDeclFnArgDocs</span> <span class='hs-layout'>(</span><span class='hs-conid'>SigD</span> <span class='hs-layout'>(</span><span class='hs-conid'>TypeSig</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>ty</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>getTypeFnArgDocs</span> <span class='hs-varid'>ty</span> <a name="line-28"></a><span class='hs-definition'>getDeclFnArgDocs</span> <span class='hs-layout'>(</span><span class='hs-conid'>ForD</span> <span class='hs-layout'>(</span><span class='hs-conid'>ForeignImport</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>ty</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>getTypeFnArgDocs</span> <span class='hs-varid'>ty</span> <a name="line-29"></a><span class='hs-definition'>getDeclFnArgDocs</span> <span class='hs-layout'>(</span><span class='hs-conid'>TyClD</span> <span class='hs-layout'>(</span><span class='hs-conid'>TySynonym</span> <span class='hs-layout'>{</span><span class='hs-varid'>tcdSynRhs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ty</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>getTypeFnArgDocs</span> <span class='hs-varid'>ty</span> <a name="line-30"></a><span class='hs-definition'>getDeclFnArgDocs</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>empty</span> <a name="line-31"></a> <a name="line-32"></a><a name="getSigFnArgDocs"></a><span class='hs-definition'>getSigFnArgDocs</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Sig</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Int</span> <span class='hs-conid'>HsDocString</span> <a name="line-33"></a><span class='hs-definition'>getSigFnArgDocs</span> <span class='hs-layout'>(</span><span class='hs-conid'>TypeSig</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>ty</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>getTypeFnArgDocs</span> <span class='hs-varid'>ty</span> <a name="line-34"></a><span class='hs-definition'>getSigFnArgDocs</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>empty</span> <a name="line-35"></a> <a name="line-36"></a><a name="getTypeFnArgDocs"></a><span class='hs-definition'>getTypeFnArgDocs</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>LHsType</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Int</span> <span class='hs-conid'>HsDocString</span> <a name="line-37"></a><span class='hs-definition'>getTypeFnArgDocs</span> <span class='hs-varid'>ty</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>getLTypeDocs</span> <span class='hs-num'>0</span> <span class='hs-varid'>ty</span> <a name="line-38"></a> <a name="line-39"></a> <a name="line-40"></a><a name="getLTypeDocs"></a><span class='hs-definition'>getLTypeDocs</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LHsType</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Int</span> <span class='hs-conid'>HsDocString</span> <a name="line-41"></a><span class='hs-definition'>getLTypeDocs</span> <span class='hs-varid'>n</span> <span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>ty</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>getTypeDocs</span> <span class='hs-varid'>n</span> <span class='hs-varid'>ty</span> <a name="line-42"></a> <a name="line-43"></a><a name="getTypeDocs"></a><span class='hs-definition'>getTypeDocs</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>HsType</span> <span class='hs-conid'>Name</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Map</span> <span class='hs-conid'>Int</span> <span class='hs-conid'>HsDocString</span> <a name="line-44"></a><span class='hs-definition'>getTypeDocs</span> <span class='hs-varid'>n</span> <span class='hs-layout'>(</span><span class='hs-conid'>HsForAllTy</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>ty</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>getLTypeDocs</span> <span class='hs-varid'>n</span> <span class='hs-varid'>ty</span> <a name="line-45"></a><span class='hs-definition'>getTypeDocs</span> <span class='hs-varid'>n</span> <span class='hs-layout'>(</span><span class='hs-conid'>HsFunTy</span> <span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-layout'>(</span><span class='hs-conid'>HsDocTy</span> <span class='hs-sel'>_arg_type</span> <span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>res_type</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <a name="line-46"></a> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>insert</span> <span class='hs-varid'>n</span> <span class='hs-varid'>doc</span> <span class='hs-varop'>$</span> <span class='hs-varid'>getLTypeDocs</span> <span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-varop'>+</span><span class='hs-num'>1</span><span class='hs-layout'>)</span> <span class='hs-varid'>res_type</span> <a name="line-47"></a><span class='hs-definition'>getTypeDocs</span> <span class='hs-varid'>n</span> <span class='hs-layout'>(</span><span class='hs-conid'>HsFunTy</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>res_type</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>getLTypeDocs</span> <span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-varop'>+</span><span class='hs-num'>1</span><span class='hs-layout'>)</span> <span class='hs-varid'>res_type</span> <a name="line-48"></a><span class='hs-definition'>getTypeDocs</span> <span class='hs-varid'>n</span> <span class='hs-layout'>(</span><span class='hs-conid'>HsDocTy</span> <span class='hs-sel'>_res_type</span> <span class='hs-layout'>(</span><span class='hs-conid'>L</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>doc</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>singleton</span> <span class='hs-varid'>n</span> <span class='hs-varid'>doc</span> <a name="line-49"></a><span class='hs-definition'>getTypeDocs</span> <span class='hs-keyword'>_</span> <span class='hs-sel'>_res_type</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>empty</span> <a name="line-50"></a> </pre></body> </html>