diff options
Diffstat (limited to 'src/Documentation/Haddock.hs')
-rw-r--r-- | src/Documentation/Haddock.hs | 89 |
1 files changed, 0 insertions, 89 deletions
diff --git a/src/Documentation/Haddock.hs b/src/Documentation/Haddock.hs deleted file mode 100644 index 1ff5cf75..00000000 --- a/src/Documentation/Haddock.hs +++ /dev/null @@ -1,89 +0,0 @@ ------------------------------------------------------------------------------ --- | --- Module : Documentation.Haddock --- Copyright : (c) David Waern 2010 --- License : BSD-like --- --- Maintainer : haddock@projects.haskellorg --- Stability : experimental --- Portability : portable --- --- The Haddock API: A rudimentory, highly experimental API exposing some of --- the internals of Haddock. Don't expect it to be stable. ------------------------------------------------------------------------------ -module Documentation.Haddock ( - - -- * Interface - Interface(..), - InstalledInterface(..), - createInterfaces, - processModules, - - -- * Export items & declarations - ExportItem(..), - DocForDecl, - FnArgsDoc, - - -- * Cross-referencing - LinkEnv, - DocName(..), - - -- * Instances - DocInstance, - InstHead, - - -- * Documentation comments - Doc, - DocH(..), - Example(..), - Hyperlink(..), - DocMarkup(..), - Documentation(..), - ArgMap, - AliasMap, - WarningMap, - DocMap, - HaddockModInfo(..), - markup, - - -- * Interface files - InterfaceFile(..), - readInterfaceFile, - nameCacheFromGhc, - freshNameCache, - NameCacheAccessor, - - -- * Flags and options - Flag(..), - DocOption(..), - - -- * Error handling - HaddockException(..), - - -- * Program entry point - haddock, - haddockWithGhc, - getGhcDirs, - withGhc -) where - - -import Haddock.InterfaceFile -import Haddock.Interface -import Haddock.Types -import Haddock.Options -import Haddock.Utils -import Haddock - - --- | Create 'Interface' structures from a given list of Haddock command-line --- flags and file or module names (as accepted by 'haddock' executable). Flags --- that control documentation generation or show help or version information --- are ignored. -createInterfaces - :: [Flag] -- ^ A list of command-line flags - -> [String] -- ^ File or module names - -> IO [Interface] -- ^ Resulting list of interfaces -createInterfaces flags modules = do - (_, ifaces, _) <- withGhc flags (readPackagesAndProcessModules flags modules) - return ifaces |