haddock.git - Haddock with an org backend (haddorg).

	Commit message (Collapse)	Author	Age	Files	Lines
...
*	Remove claim of backwards compatibility from docs for readInterfaceFile	David Waern	2008-05-01	1	-2/+0
\|
*	Fix some trivial warnings in H.InterfaceFile	David Waern	2008-02-10	1	-4/+7
\|
*	Change the representation of DocNames	David Waern	2008-02-09	1	-21/+2
\| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \|	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.
*	Add documentation for readInterfaceFile	David Waern	2008-01-07	1	-1/+5
\|
*	Don't require -B <ghc-libdir> when no argument files	David Waern	2007-11-11	1	-8/+18
\| \| \| \| \| \|	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.
*	Introduce InstalledInterface structure and add more stuff to the .haddock files	David Waern	2007-11-10	1	-26/+190
\| \| \| \| \| \| \|	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).
*	Synch loading of names from .haddock files with GHC's name cache	David Waern	2007-11-08	1	-8/+12
\|
*	Refactoring -- get rid of Haddock.Packages	David Waern	2007-10-18	1	-34/+38
\|
*	Add support for --read-interface again	David Waern	2007-10-18	1	-6/+10
\|
*	Rename HaddockModule to Interface	David Waern	2007-08-30	1	-5/+5
\|
*	Major refactoring	David Waern	2007-08-29	1	-1/+1
\|
*	Add top module comment to all files	David Waern	2007-08-17	1	-0/+8
\|
*	Fix conflicts	David Waern	2007-07-11	1	-1/+1
\|
*	update to compile with the latest GHC & Cabal	Simon Marlow	2007-05-30	1	-2/+3
\|
*	Follow changes to record constructor representation	David Waern	2007-07-11	1	-1/+1
\|
*	Do save/read of interface files properly	davve@dtek.chalmers.se	2007-04-05	1	-22/+167
\|
*	De-flatten the namespace	davve@dtek.chalmers.se	2007-03-25	1	-1/+1
\|
*	Start work on Haddock API	davve@dtek.chalmers.se	2007-03-25	1	-0/+50