Skip to content
Snippets Groups Projects
CHANGES 17.5 KiB
Newer Older
Changes in version 2.15.0

 * Always read in prologue files as UTF8 (#286 and Cabal #1721)

Changes in version 2.14.2

 * Always drop --split-objs GHC flag for performance reasons (#292)

 * Print kind signatures GADTs (#85)

 * Drop single leading whitespace when reasonable from @-style blocks (#201)

 * Fix crashes associated with exporting data family record selectors (#294)

Mateusz Kowalczyk's avatar
Mateusz Kowalczyk committed
Changes in version 2.14.1

 * Render * and -> with their UnicodeSyntax equivalents if -U is enabled

 * Display minimal complete definitions for type classes

 * Hide right hand side of TF instances with hidden names on the RHS

Simon Hengel's avatar
Simon Hengel committed
Changes in version 2.14.0

 * Print entities with missing documentation (#258)

 * Print a warning message when given `-optghc` instead of `--optghc` (#5)

 * Add `--compatible-interface-versions` (#231)

 * Allow to generate latex documentation for FFI declarations (#247)

 * Add copyright and license information to generated documentation

 * Improved to Unicode support

Mateusz Kowalczyk's avatar
Mateusz Kowalczyk committed
 * Bold markup support

 * Nested paragraphs

 * Better escaping

 * Header markup

 * Parser should no longer fail to parse any markup

 * {-# OPTIONS_HADDOCK show-extensions #-} pragma will show the GHC extensions
   enabled in the module.

Mateusz Kowalczyk's avatar
Mateusz Kowalczyk committed
 * Properly render License field (#271)

 * Print type/data family instances (for exported types only)
Niklas Haas's avatar
Niklas Haas committed
 * Fix display of poly-kinded type operators (#189)
Mateusz Kowalczyk's avatar
Mateusz Kowalczyk committed
 * PatternSynonyms support

 * Fix display of implicit parameters (#260)

 * Fix rendering of Contents when links are present (#276)

 * Fix documentation duplication on record fields (#195)

Niklas Haas's avatar
Niklas Haas committed
 * Add `--source-entity-line` for exact line links (eg. things defined
   inside TH splices) (#79)

 * Display fixity information for names with nonstandard fixities

 * Bird tracks specified like "> code" no longer suffer from an extra leading
   space in the code output
Mateusz Kowalczyk's avatar
Mateusz Kowalczyk committed

Simon Hengel's avatar
Simon Hengel committed
Changes in version 2.13.2

Simon Hengel's avatar
Simon Hengel committed
 * Handle HsExplicitListTy in renamer (#213)
Simon Hengel's avatar
Simon Hengel committed

 * Allow haddock markup in deprecation messages

 * Export more types from Documentation.Haddock

 * Include everything that is required to run the test suite with the cabal
   package (#230)

Changes in version 2.13.1

 * Hide instances that are "internal" to a module

 * Add support for properties in documentation

 * Fix a bug with spurious superclass constraints

 * Fix and extend the Haddock API

waern's avatar
waern committed
Changes in version 2.12.0

 * Labeled URLs (e.g <http://example.net/ some label>)

waern's avatar
waern committed
 * Improved memory usage (new dependency: deepseq)

waern's avatar
waern committed
Changes in version 2.11.0

 * Show deprecation messages for identifiers

 * List identifiers declared on the same line (with a common type) separately

 * Don't crash on unicode strings in doc comments

 * Fix reporting of modules safe haskell mode

waern's avatar
waern committed
 * Fix a case where we were generating invalid xhtml
waern's avatar
waern committed

 * Improved --qual option (no crashes, proper error messages)

Herbert Valerio Riedel's avatar
Herbert Valerio Riedel committed
 * A new --qual option "aliased" which qualifies identifiers by the module alias
   used in the source code
waern's avatar
waern committed

 * The Haddock API restores GHC's static flags after invocation

 * Access to unexported identifiers through the Haddock API again

waern's avatar
waern committed
Changes in version 2.10.0

 * Require GHC >= 7.4

 * Safe Haskell indications on module pages

 * Type declarations on identifiers no longer necessary

 * Add flag --interface-version

 * Warn when comment refers to in-scope identifier without documentation

 * Bug fix: links to out-of-scope things (#78)

 * Bug fix: module references to other packages work again

waern's avatar
waern committed
Changes in version 2.9.4

  * Require GHC >= 7.2

  * Support Alex 3.x

waern's avatar
waern committed
Changes in version 2.9.3

  [This is the version that comes with GHC 7.2.1 although it claims it's 2.9.2!]

  * Build with GHC 7.2.1

  * Support blank lines in results of examples

  * A type signature for multiple names generates one signature in the output

  * Minor bug fixes

waern's avatar
waern committed
Changes in version 2.9.2

waern's avatar
waern committed
  * Build with GHC 7.0.2

waern's avatar
waern committed
  * Write Hoogle output in utf8; fixes GHC build on Windows

waern's avatar
waern committed
Changes in version 2.9.1

  * Fix build in GHC tree

  * Improve .cabal file

waern's avatar
waern committed
Changes in version 2.9.0

  * Drop support for ghc < 7

  * New flag --qual for qualification of names

  * Print doc coverage information to stdout when generating docs

  * Include an 'All' option in the A-Z subdivided index

  * Make TOC group header identifiers validate

  * Minor changes to the API

Changes in the version that comes with GHC 7.0.1
  [This version claims it is 2.8.0 but is actually based on 2.8.1]
waern's avatar
waern committed

  * Fix URL creation on Windows: Use / not \ in URLs.
waern's avatar
waern committed

waern's avatar
waern committed

waern's avatar
waern committed
Changes in version 2.8.1

  * Fix build on Windows with MinGW

waern's avatar
waern committed
Changes in version 2.8.0

  * HTML backend completely rewritten to generate semantically rich XHTML
    using the xhtml package.

  * New default CSS based on the color scheme chosen for the new Haskell
    wiki, with a pull-out tab for the synopsis.

  * Theme engine based on CSS files. Themes can be switched from the
    header menu. (New flags --built-in-themes and --theme. The latter
    is an alias for --css which now has extended semantics).

  * Markup support for executable examples/unit-tests. To be used with an
    upcoming version of the DocTest program.

  * Addition of a LaTeX backend.

  * Frames-mode can be enabled from the header menu.
waern's avatar
waern committed

  * Path to source entities can be specified per package, so that source
    links work for cross-package documentation.

  * Support for a second form of enumerated lists (1. 2. etc).

  * Additions and changes to the Haddock API.

  * New flag --no-tmp-comp-dir to tell Haddock to write and pick up
    compilation files (.o, .hi, etc) to/from GHC's output directory instead
    of a temporary directory.

  * Various bug fixes.

-----------------------------------------------------------------------------

Changes in version 2.6.1 (bug fix release from the stable branch)

  * Fix #128

-----------------------------------------------------------------------------

waern's avatar
waern committed
Changes in version 2.7.2

  * Add Paths_haddock to library

-----------------------------------------------------------------------------

waern's avatar
waern committed
Changes in version 2.7.1:

  * Fix problems with library part of .cabal file

-----------------------------------------------------------------------------

waern's avatar
waern committed
Changes in version 2.7.0:

  * Instances can be commented

  * The Haddock API now exposes more of the internals of Haddock

  * Bug fixes (most importantly #128)

-----------------------------------------------------------------------------

waern's avatar
waern committed
Changes in version 2.6.0:

  * Drop support for GHC 6.10.*

  * Add support for GHC 6.12.1

  * Cross-package documentation: full documentation show up when re-exporting
    things coming from external packages

  * Lexing and parsing the Haddock comment markup is now done in Haddock
    again, instead of in GHC

  * Slightly prettier printing of instance heads

  * Support platforms for which GHC has no native code generator

  * Add a flag --print-ghc-libdir

  * Minor bug fixes

-----------------------------------------------------------------------------

waern's avatar
waern committed
Changed in version 2.5.0:

  * Drop support for GHC 6.8.*

  * Add support for GHC 6.10.3 and 6.10.4

  * Revert to the old multi-page index for large packages (#106)

  * Show GADT records in the generated documentation

  * Create output directory if it doesn't exist (#104)

  * Use the native codegen instead of compiling via C for TH modules

  * Add --use-unicode flag for displaying prettier versions of common symbols

Herbert Valerio Riedel's avatar
Herbert Valerio Riedel committed
  * Multiple verbosity levels: remove --verbose and add --verbosity=n
waern's avatar
waern committed

-----------------------------------------------------------------------------

waern's avatar
waern committed
Changed in version 2.4.2:

  * Support GHC 6.10.2

  * Haddock no longer crashes on Template Haskell modules (#68)
    (only with GHC 6.10.2 or above)

  * Fix problem with Template Haskell-generated declarations disappearing (#59)

  * Generate two anchors for each link for compatibility between IE and Opera
    (#45)

  * Improved error messages

  * Show re-exports from external packages again (GHC ticket #2746)

  * Store hidden modules in .haddock files again (needed by the haddock
    library)

  * Avoid processing boot modules

  * Pragmas may exist between document comments and declarations

  * Do not indicate that a constructor argument is unboxed

Herbert Valerio Riedel's avatar
Herbert Valerio Riedel committed
  * Fix problem with non-working links to ghc-prim
waern's avatar
waern committed

  * Allow referring to a specific section within a module in a module link
    (#65)

  * Fixes to the Hoogle backend
waern's avatar
waern committed
  * Improvements to the haddock library
waern's avatar
waern committed

waern's avatar
waern committed
  * Many other fixes (including #67, #69, #58, #57)
waern's avatar
waern committed

-----------------------------------------------------------------------------

Changed in version 2.4.1:

  * Depend on base 4.* when GHC >= 6.9, otherwise 3.*

-----------------------------------------------------------------------------

waern's avatar
waern committed
Changed in version 2.4.0:

waern's avatar
waern committed
  * Add framed view of the HTML documentation
waern's avatar
waern committed

  * Build with GHC 6.8.2 and 6.8.3 again

waern's avatar
waern committed
  * Support images in documentation comments again
waern's avatar
waern committed

  * Small improvements to the Hoogle output

waern's avatar
waern committed
  * A few bugs has been fixed

waern's avatar
waern committed
-----------------------------------------------------------------------------

waern's avatar
waern committed
Changed in version 2.3.0:

  * Support for GHC 6.10.1

  * Slightly improved space usage

  * Fix a bug that made hidden modules show up in the contents & index pages

  * Fix a bug that made Haddock load modules twice

  * Improvements to the Hoogle output

-----------------------------------------------------------------------------

Changed in version 2.2.2:

  * Relax version dependency on ghc-paths

waern's avatar
waern committed
-----------------------------------------------------------------------------

waern's avatar
waern committed
Changes in version 2.2.1:
waern's avatar
waern committed

waern's avatar
waern committed
  * Support for GHC 6.8.3

  * The Hoogle backend is back, thanks to Neil Mitchell. The plan is to be
    compatible with the upcoming Hoogle 4 pre-release

  * Show associated types in the documentation for class declarations

  * Show type family declarations

  * Show type equality predicates

  * Major bug fixes (#1 and #44)

  * It is no longer required to specify the path to GHC's lib dir

  * Remove unnecessary parenthesis in type signatures

-----------------------------------------------------------------------------
waern's avatar
waern committed

waern's avatar
waern committed
Changes in version 2.1.0:

  * Fix a bug that made links point to the defining module instead
    of the "best" one (e.g Int pointing to GHC.Base instead of Data.Int)

  * Fix a couple of smaller bugs

  * The representation of DocName was changed in the library

  * Add a flag --no-warnings for turning off warnings

-----------------------------------------------------------------------------

David Waern's avatar
David Waern committed
Changes in version 2.0.0.0:

  * The GHC API is used as the front-end

  * Haddock now understands all syntax understood by GHC 6.8.2

  * Haddock can generate documentation for some of the language extensions
David Waern's avatar
David Waern committed
    in GHC 6.8.2
Herbert Valerio Riedel's avatar
Herbert Valerio Riedel committed
  * Format of module attributes has changed. The only way of specifying
Mateusz Kowalczyk's avatar
Mateusz Kowalczyk committed
    module attributes is via a new OPTIONS_HADDOCK pragma. Example:
David Waern's avatar
David Waern committed
    {-# OPTIONS_HADDOCK hide, prune #-}

David Waern's avatar
David Waern committed
  * Haddock understands literate source files

  * Add a small library to read Haddock's interface files

David Waern's avatar
David Waern committed
  * Add a flag -B for passing the path to the GHC lib dir
David Waern's avatar
David Waern committed
  * Add a flag --optghc for passing options to GHC
David Waern's avatar
David Waern committed
  * Add a flag --ghc-version for printing the GHC version
David Waern's avatar
David Waern committed

  * Remove --use-package, --allow-missing-html, --ghc-pkg, in favour of only
    supporting --read-interface

David Waern's avatar
David Waern committed
  * Remove --package flag, the GHC flag -package-name can be used instead

  * Remove --no-implicit-prelude flag, the GHC flag -XNoImplicitPrelude can
David Waern's avatar
David Waern committed
    be used instead
David Waern's avatar
David Waern committed

David Waern's avatar
David Waern committed
-----------------------------------------------------------------------------

Changes in version 0.9:

  * Infix type operators, e.g., first :: a~>a' -> (a,b)~>(a',b)

  * Add a search box to the index page which automatically narrows
    the index to the search as you type (thanks to Neil Mitchell).

  * Add a --ghc-pkg flag

  * Add a flag --allow-missing-html

  * URL expansion for %%, %L, %{LINE}

  * added substitution %{FILE///c}

  * Lexing of /.../ is now more like '...', in that a / character must
    be matched by another / character on the same line, otherwise it
    is treated as a literal '/'.  This removes a common source of
    accidental parse errors in documentation.

  * Various bugs were fixed.

  * Cabal 1.2 is now required, and Haddock builds with GHC 6.8.x.

-----------------------------------------------------------------------------

simonmar's avatar
simonmar committed
Changes in version 0.8:

Simon Marlow's avatar
Simon Marlow committed
  * Haddock has a Cabal build system, and will build on Windows without
    Cygwin or MSYS.  GHC 6.4 or later is required.

  * New options: --comments-base, --comments-module, --comments-entity
    for generating links to pages (eg. wiki) for collecting user comments.

  * New options: --source-base, --source-module, --source-entity
    for generating links to source code.  Haddock now understands
    {-# LINE #-} pragmas, which means it can figure out the correct
    name for the source file even if the file is preprocessed.

  * Haddock generates output for populating the Hoogle search engine.

  * New markup <<url>> for including images.

simonmar's avatar
simonmar committed
-----------------------------------------------------------------------------

Changes in version 0.7:

  * Changes in the way Haddock decides where to direct hyperlinks.  Each entity
    is now assigned a single "home" module, and all hyperlinks are directed
    to that module.  See the docs ("Hyperlinking and re-exported entities")
    for details.

  * New options --ignore-all-exports, --hide

  * New option --use-package for creating documentation that hyperlinks to
    the HTML documentation for existing packages on your system.  It works
    by querying ghc-pkg for the location of the Haddock interface and
    HTML for the given package.

  * Parts of the HTML documentation, notably lists of instances, are
    now "collapsible" with a +/- button.  Also, the contents page is now
    in the form of tree in which subtrees can be collapsed.

  * Support for Microsoft DevHelp and HtmlHelp 2.0 formats.

  * Support for a short description for each module for the contents page.

  * Compiles with GHC 6.4+

  * Various bugfixes

-----------------------------------------------------------------------------

Changes in version 0.6:

  * Implicit parameters, zip comprehensions and 'mdo' are now
    supported by the parser.

  * Some lexical bugs were fixed, mainly concerning literal paragraphs
    next to non-literal paragraphs.

  * New options:  --gen-index, --use-index, --gen-contents and --use-contents,
    for generting a combined index and contents for several libraries
    from the appropriate .haddock files.

  * There is now one index rather than separate Function/Constructor and
    Type/Class indices.  Where a name refers to several entities, these
    are listed separately in the index.

  * New option: -v, elicits more verbose warnings.  Some warnings are
    now turned off by default; Haddock should be a little less noisy
    in general.

Mateusz Kowalczyk's avatar
Mateusz Kowalczyk committed
  * Markup for definition lists has been added.  See the documentation
    for details.

  * New option: --package for setting the package name.  The package
    is listed alongside each module name in the combined contents.

  * Entities which are re-exported from another package now at least
    leave a hyperlink in the generated HTML, rather than nothing at all.

  * Some fixes for bugs which caused incorrect hyperlinks in the
    generated HTML.  In particular, instances should now be linked
    correctly.

  * Some aesthetic improvements to the generated HTML.

-----------------------------------------------------------------------------

Changes in version 0.5:

  * Compiles with recent versions of GHC.

  * A few bugs have been fixed.

  * New labelling/linking feature (see "Anchors" in the manual).

-----------------------------------------------------------------------------

Changes in version 0.4:

  * Import declarations which list entities in parentheses, or with
    hiding clauses, are now properly supported.  Modulo one or two
    small infelicities, the full Haskell modules system is now supported.

  * Haddock is now more flexible about the placing of separators
    (commas, semicolons) in relation to doc comments.

  * There is support for generating and reading "interface files"
    which describe the exports of a set of modules.  This is useful
    for generating documentation which hyperlinks to
    previously-generated documentation.
  * Support for generating the extra files required by the Microsoft
    Help compiler.

  * New option: --prologue specifies a file of documentation which is
    placed on the contents page.

  * Many bugs fixed

-----------------------------------------------------------------------------
Changes in version 0.3:
Mateusz Kowalczyk's avatar
Mateusz Kowalczyk committed

  * Documentation on individual function arguments is now implemented

  * Links can be made to identifiers that aren't in scope, by using
    the fully qualified name.

  * Instances are collected and listed with the appropriate classes
    and datatypes (not for derived instances yet).

  * Single quotes are only interpreted specially when they surround a
    legal Haskell identifier, otherwise they are treated literally.

  * Bird-tracked text is now literal.  If you want marked-up text in
    a code block, use the @...@ notation instead.

  * Various changes to the layout, it generally looks nicer now.

  * Various bugs fixed.

-----------------------------------------------------------------------------
Changes in version 0.2:

  * The [...] markup for typewriter font has been changed to @...@.
  * Module attributes introduced (see the documentation for details).

  * {- ... -} style comments may now be used for documentation annotations

  * Recursive modules are detected and reported as an error.

  * Existential constructors and rank-N types are now groked by the parser

  * Some type rendering cleaned up

  * `abc' is accepted as well as 'abc' to markup an identifier

  * Several bugs fixed, and error messages improved.