From: Duncan C. <dun...@wo...> - 2006-11-13 03:13:10
|
Thu Nov 2 15:52:09 PST 2006 Duncan Coutts <du...@co...> * Remove unused code an exports hunk ./tools/apiGen/FormatDocs.hs 17 - toStudlyCaps, hunk ./tools/apiGen/FormatDocs.hs 18 - haddocFormatSpans, hunk ./tools/apiGen/FormatDocs.hs 21 - addVersionParagraphs hunk ./tools/apiGen/FormatDocs.hs 23 -import Api (NameSpace(..), Object(..), Method(..)) hunk ./tools/apiGen/FormatDocs.hs 25 -import MarshalFixup (cTypeNameToHSType, knownMiscType, fixCFunctionName - ,fixModuleAvailableSince) +import MarshalFixup (cTypeNameToHSType, knownMiscType, fixCFunctionName) hunk ./tools/apiGen/FormatDocs.hs 87 - -addVersionParagraphs :: NameSpace -> ModuleDoc -> ModuleDoc -addVersionParagraphs namespace apiDoc = - apiDoc { - moduledoc_summary = moduledoc_summary apiDoc ++ moduleVersionParagraph - ++ moduleDeprecatedParagraph, - moduledoc_functions = functionVersionParagraphs moduleVersion (moduledoc_functions apiDoc), - moduledoc_since = moduleVersion - } - where functionVersionParagraphs :: String -> [FuncDoc] -> [FuncDoc] - functionVersionParagraphs baseVersion funcdocs = - [ if funcdoc_since funcdoc > baseVersion - then funcdoc { - funcdoc_paragraphs = funcdoc_paragraphs funcdoc ++ - let line = "Available since " ++ (let name = namespace_name namespace - in if name == "Gtk" then "Gtk+" else name) - ++ " version " ++ funcdoc_since funcdoc - in [DocParaListItem [DocText line]] - } - else let method = lookup (funcdoc_name funcdoc) methodMap - methodDeprecated = maybe False method_deprecated method - objectDeprecated = maybe False object_deprecated object - in if methodDeprecated && not objectDeprecated - then funcdoc { - funcdoc_paragraphs = funcdoc_paragraphs funcdoc ++ - let line = "Warning: this function is deprecated " - ++ "and should not be used in newly-written code." - in [DocParaListItem [DocText line]] - } - else funcdoc - | funcdoc <- funcdocs ] - where methodMap = [ (method_cname method, method) - | method <- maybe [] object_methods object ] - [_$_] - moduleVersionParagraph = - case moduleVersion of - "" -> [] - since -> - let line = "Module available since " ++ (let name = namespace_name namespace - in if name == "Gtk" then "Gtk+" else name) - ++ " version " ++ since - in [DocParaListItem [DocText line]] [_$_] - [_$_] - -- figure out if the whole module appeared in some version of gtk later [_$_] - -- than the original version - moduleVersion :: String - moduleVersion | null fixed = case [ funcdoc_since funcdoc - | funcdoc <- moduledoc_functions apiDoc ] of - [] -> "" - versions -> minimum versions - | otherwise = fixed - where fixed = fixModuleAvailableSince (moduledoc_name apiDoc) - - moduleDeprecatedParagraph = - if maybe False object_deprecated object - then let line = "Warning: this module is deprecated " - ++ "and should not be used in newly-written code." - [_$_] - in [DocParaListItem [DocText line]] - else [] - [_$_] - object = lookup (moduledoc_name apiDoc) - [ (object_cname obj, obj) - | obj <- namespace_objects namespace ] |