Move sources under haddock-api/src

1 files changed, 89 insertions, 0 deletions

diff --git a/haddock-api/src/Documentation/Haddock.hs b/haddock-api/src/Documentation/Haddock.hs
new file mode 100644
index 00000000..1ff5cf75
--- /dev/null
+++ b/haddock-api/src/Documentation/Haddock.hs
@@ -0,0 +1,89 @@
+-----------------------------------------------------------------------------
+-- |
+-- 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