| Commit message (Collapse) | Author | Age | Files | Lines |
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Ross Paterson reported a bug where links would point to the defining module
instead of the "best" module for an identifier (e.g Int pointing to GHC.Base
instead of Data.Int). This patch fixes this problem by refactoring the way
renamed names are represented. Instead of representing them by:
> data DocName = Link Name | NoLink Name
they are now represented as such:
> data DocName = Documented Name Module | Undocumented Name
and the the link-env looks like this:
> type LinkEnv = Map Name Module
There are several reasons for this. First of all, the bug was caused by
changing the module part of Names during the renaming process, without changing
the Unique field. This caused names to be overwritten during the loading of
.haddock files (which caches names using the NameCache of the GHC session).
So we might create new Uniques during renaming to fix this (but I'm not
sure that would be problem-free). Instead, we just keep the Name and add the
Module where the name is best documented, since it can be useful to keep
the original Name around (for e.g. source-code location info and for users of
the Haddock API).
Also, the names Link/NoLink don't really make sense, since wether to use
links or not is entirely up to the users of DocName.
In the process of following this change into H.Backends.Html I removed the
assumption that binder names are Undocumented (which was just an unnecessary
assumption, the OccName is the only thing needed to render these). This will
probably make it possible to get rid of the renamer and replace it with a
traversal from SYB or Uniplate.
Since DocName has changed, InterfaceFile has changed so this patch also
increments the file-format version. No backwards-compatibility is implemented.
|
| |
|
| |
|
| |
|
|
|
|
|
|
|
| |
Thu Dec 6 15:00:10 CET 2007 Simon Marlow <simonmar@microsoft.com>
* Source links must point to the original module, not the referring
module
|
| |
|
| |
|
| |
|
| |
|
|
|
|
|
| |
This is also a refactoring to share this code for rendering predicates.
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
|
|
| |
on the base library with IE, the new version guarantees less than O(log n) operations be performed, where n is the number in the list (before was always O(n))
|
| |
|
|
|
|
|
|
| |
Change readInterfaceFile to take a Maybe Session, to avoid having to pass -B
<ghc-libdir> to Haddock when there're no source files to process. This is nice when
computing contents/index for external packages.
|
| |
|
|
|
|
|
|
|
|
|
|
| |
Thu Apr 19 20:23:40 CEST 2007 Wolfgang Jeltsch <g9ks157k@acme.softbase.org>
* bug fix
When Haddock was invoked with the --ignore-all-exports flag but the ignore-exports module attribute wasn't used, hyperlinks weren't created for
non-exported names.
This fix might not be as clean as one would wish (since --ignore-all-exports now results in ignore_all_exports = True *and* an additional
OptIgnoreExports option for every module) but at least the bug seems to be resolved now.
|
|
|
|
|
|
| |
Sat Apr 21 04:36:43 CEST 2007 Roberto Zunino <zunrob@users.sf.net>
* URL expansion for %%, %L, %{LINE}
|
| |
|
| |
|
|
|
|
| |
constructors, instances or comments. Gets better HTML 4.01 compliance
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
|
|
|
|
| |
haddock.js will be run automatically by Windows when you type
'haddock' if it is found on the PATH, so rename to avoid confusion.
Spotted by Adrian Hey.
|
| |
|
|
|
|
| |
<table></table> tag being generated, which is not valid HTML 4.01
|
| |
|
| |
|
|
|
|
|
| |
haddock depending on the network causes a circular dependency
at least if you want to build the network lib with haddock docs.
|
|
|
|
|
|
|
|
|
| |
This also merges an old patch by Augustsson:
Wed Jul 12 19:54:36 CEST 2006 lennart.augustsson@credit-suisse.com
* Print type definitions like signatures if given arrows.
|
| |
|
|
|
|
| |
--gen-contents/--gen-index
|
|
|
|
|
|
|
| |
We introduce InstalledInterface capturing the part of Interface that is stored
in the interface files. We change the ppHtmlContents and ppHtmllIndex to take
this structure instead of a partial Interface. We add stuff like the doc map
and exported names to the .haddock file (via InstalledInterface).
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|