aboutsummaryrefslogtreecommitdiff
path: root/src/Main.hs
Commit message (Collapse)AuthorAgeFilesLines
...
* Add Hoogle output optionNeil Mitchell2006-02-261-0/+7
|
* Make the --help output fit in 80 columns.Duncan Coutts2006-01-231-15/+16
| | | | | | This is a purely cosmetic patch, feel free to ignore it. The only trickery going on is that we don't display the deprecated -s, --source flags in the help message, but we do still accept them.
* Remove the complex substitutions and add more command line flags instead.Duncan Coutts2006-01-231-19/+29
| | | | | | | | | | | | | | | | | | | Instead of incomprehensable URL substitutions like ${MODULE/./-|?m=%} we now use three seperate command line flags for the top level, per-module and per-entity source and wiki links. They are: --source-base, --source-module, --source-entity --comments-base, --comments-module, --comments-entity We leave -s, --source as an alias for --source-module which is how that option behaved previously. The long forms of the substitutions are still available, ${FILE} ${MODULE} etc and the only non-trivial substitution is ${MODULE/./c} to replace the '.' characters in the module name with any other character c. eg ${MODULE/./-} Seperating the source and wiki url flags has the added bonus that they can be turned on or off individually. So users can have per-module links for example without having to also have per-entity links.`
* Extend URL variable expansion syntax and add source links to the contents pageDuncan Coutts2006-01-221-2/+4
| | | | | | | | | | | | | | | | | | | | | | | | | Like the wiki link on the contents and index page, add a source code link too. Extend the wiki & source URL variable expansion syntax. The original syntax was: %F for the source file name (the .hs version only, not the .lhs or .hs.pp one) %M for the module name (with '.' replaced by '/') The new syntax is: %F or %{FILE} for the original source file name %M or %{MODULE} for the module name (no replacements) %N or %{NAME} for the function/type export name %K or %{KIND} for a type/value flag "t" or "v" with these extensions: %{MODULE/./c} to replace the '.' module seperator with any other char c %{VAR|some text with the % char in it} which means if the VAR is not in use in this URL context then "" else replace the given text with the '%' char replaced by the string value of the VAR. This extension allows us to construct URLs wit optional parts, since the module/file name is not available for the URL in the contents/index pages and the value/type name is not available for the URL at the top level of each module.
* Teach haddock about line pragmas and add accurate source code linksDuncan Coutts2006-01-211-5/+10
| | | | | | | | | | | | | | | | | | | | | Teach haddock about C and Haskell style line pragmas. Extend the lexer/parser's source location tracking to include the file name as well as line/column. This way each AST item that is tagged with a SrcLoc gets the original file name too. Use this original file name to add source links to each exported item, in the same visual style as the wiki links. Note that the per-export source links are to the defining module rather than whichever module haddock pretends it is exported from. This is what we want for source code links. The source code link URL can also contain the name of the export so one could implement jumping to the actual location of the function in the file if it were linked to an html version of the source rather than just plain text. The name can be selected with the %N wild card. So for linking to the raw source code one might use: --source=http://darcs/haskell.org/foo/%F Or for linking to html syntax highlighted code: --source=http://darcs/haskell.org/foo/%M.html#%N
* Add an optional wiki link for each top level exported name.Duncan Coutts2006-01-191-2/+4
| | | | | | | | | | | | | | In each module, for each "top level" exported entity we add a hyper link to a corresponding wiki page. The link url gets the name of the exported entity as a '#'-style anchor, so if there is an anchor in the page with that name then the users browser should jump directly to it. By "top level" we mean functions, classes, class members and data types (data, type, newtype), but not data constructors, class instances or data type class membership. The link is added at the right of the page and in a small font. Hopefully this is the right balance of visibility/distraction. We also include a link to the wiki base url in the contents and index pages.
* Add a --wiki=URL flag to add a per-module link to a correspondng wiki page.Duncan Coutts2006-01-171-2/+10
| | | | | | | | So each html page gets an extra link (placed next to the source code and contents links) to a corresponding wiki page. The idea is to let readers contribute their own notes, examples etc to the documentation. Also slightly tidy up the code for the --source option.
* First cut of Cabal build systemsimonmar2005-10-141-36/+3
|
* [haddock @ 2005-10-10 15:02:55 by simonmar]simonmar2005-10-101-2/+2
| | | | | | extractRecSel: ignore non-record constructors (fixes a crash when using datatypes with a mixture of record and non-record style constructors).
* [haddock @ 2005-05-18 12:41:59 by ross]ross2005-05-181-23/+17
| | | | fix 3 bugs in --use-package, and document it.
* [haddock @ 2005-02-04 13:36:05 by ross]ross2005-02-041-2/+34
| | | | | | | sort lists of instances by - arity of the type constructors (so higher-kinded instances come first) - name of the class - argument types
* [haddock @ 2005-02-04 12:15:52 by simonmar]simonmar2005-02-041-2/+4
| | | | | | Add attribute #not-home, to indicate that the current module should not be considered to be a home module for the each entity it exports, unless there is no other module that exports the entity.
* [haddock @ 2005-02-03 16:17:37 by ross]ross2005-02-031-1/+1
| | | | fix typo for < 6.3
* [haddock @ 2005-02-03 13:42:19 by simonmar]simonmar2005-02-031-24/+121
| | | | | | | | | | | | - add --ignore-all-exports flag, which behaves as if every module has the ignore-exports attribute (requested by Chris Ryder). - add --hide option to hide a module on the command line. - add --use-package option to get Haddock info for a package from ghc-pkg (largely untested). - remove reexports from the .haddock file, they aren't used any more.
* [haddock @ 2005-02-02 16:23:00 by simonmar]simonmar2005-02-021-201/+291
| | | | | | | | | | | | | | | | | | | | | | Revamp the linking strategy in Haddock. Now name resolution is done in two phases: - first resolve everything to original names, like a Haskell compiler would. - then, figure out the "home" location for every entity, and point all the links to there. The home location is the lowest non-hidden module in the import hierarchy that documents the entity. If there are multiple candidates, one is chosen at random. Also: - Haddock should not generate any HTML with dangling links any more. Unlinked references are just rendered as plain text. - Error reporting is better: if we can't find a link destination for an entity reference, we now emit a warning.
* [haddock @ 2005-01-28 23:19:39 by krasimir]krasimir2005-01-281-0/+4
| | | | import Foreign/Foreign.C are required for Windows
* [haddock @ 2005-01-16 15:41:21 by panne]panne2005-01-161-38/+20
| | | | Cleaned up imports and dropped support for GHC < 5.03, it never worked, anyway.
* [haddock @ 2005-01-16 14:22:44 by panne]panne2005-01-161-1/+1
| | | | Added the last missing "flip" to get identical HTML output as previous versions.
* [haddock @ 2005-01-16 14:14:39 by panne]panne2005-01-161-1/+1
| | | | Data.Map.unions is left-biased.
* [haddock @ 2005-01-16 12:58:03 by panne]panne2005-01-161-2/+2
| | | | | Correctly handle the new order of arguments for the combining function given to fromListWith.
* [haddock @ 2005-01-15 18:44:45 by panne]panne2005-01-151-91/+89
| | | | | | | | | | Make Haddock compile again after the recent base package changed. The Map/Set legacy hell has been factored out, so that all modules can simply use the new non-deprecated interfaces. Probably a lot of things can be improved by a little bit of Map/Set/List algebra, this can be done later if needed. Small note: Currently the list of instances in HTML code is reversed. This will hopefully be fixed later.
* [haddock @ 2005-01-11 10:44:37 by simonmar]simonmar2005-01-111-2/+2
| | | | Remove string gap
* [haddock @ 2004-08-26 20:08:49 by panne]panne2004-08-261-1/+1
| | | | | | | | SGML is dead, long live DocBook XML! Note: The BuildRequires tags in the spec files are still incomplete and the documentation about the DocBook tools needs to be updated, too. Stay tuned...
* [haddock @ 2004-08-10 14:33:45 by simonmar]simonmar2004-08-101-2/+3
| | | | Fixes to installation under Windows.
* [haddock @ 2004-08-09 11:55:05 by simonmar]simonmar2004-08-091-36/+107
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add support for a short description for each module, which is included in the contents. The short description should be given in a "Description: " field of the header. Included in this patch are changes that make the format of the header a little more flexible. From the comments: -- all fields in the header are optional and have the form -- -- [spaces1][field name][spaces] ":" -- [text]"\n" ([spaces2][space][text]"\n" | [spaces]"\n")* -- where each [spaces2] should have [spaces1] as a prefix. -- -- Thus for the key "Description", -- -- > Description : this is a -- > rather long -- > -- > description -- > -- > The module comment starts here -- -- the value will be "this is a .. description" and the rest will begin -- at "The module comment". The header fields must be in the following order: Module, Description, Copyright, License, Maintainer, Stability, Portability. Patches submitted by: George Russell <ger@informatik.uni-bremen.de>, with a few small changes be me, mostly to merge with other recent changes. ToDo: document the module header.
* [haddock @ 2004-08-03 19:45:30 by sof]sof2004-08-031-1/+1
| | | | ffi wibble
* [haddock @ 2004-08-01 19:52:06 by krasimir]krasimir2004-08-011-7/+3
| | | | fix some bugs. Now I have got the entire libraries documentation in HtmlHelp 2.0 format.
* [haddock @ 2004-08-01 15:14:02 by krasimir]krasimir2004-08-011-0/+3
| | | | add missing imports
* [haddock @ 2004-07-30 22:15:45 by krasimir]krasimir2004-07-301-6/+11
| | | | | | | | more stuffs - support for separated compilation of packages - the contents page now uses DHTML TreeView - fixed copyFile bug
* [haddock @ 2004-07-27 22:58:23 by krasimir]krasimir2004-07-271-15/+11
| | | | Add basic support for Microsoft HTML Help 2.0
* [haddock @ 2004-05-28 20:17:55 by mthomas]mthomas2004-05-281-1/+40
| | | | Windows: search for templates in executable directory. Unix: Haddock tries cwd first rather than error if no -l arg.
* [haddock @ 2004-05-25 10:41:46 by simonmar]simonmar2004-05-251-0/+4
| | | | | Complain if -h is used with --gen-index or --gen-contents, because it'll overwrite the new index/contents.
* [haddock @ 2004-05-19 13:10:23 by ross]ross2004-05-191-41/+46
| | | | | | | Make the handling of "deriving" slightly smarter, by ignoring data constructor arguments that are identical to the lhs. Now handles things like data Tree a = Leaf a | Branch (Tree a) (Tree a) deriving ...
* [haddock @ 2004-03-25 10:29:56 by simonmar]simonmar2004-03-251-1/+10
| | | | | | If a name is imported from two places, one hidden and one not, choose the unhidden one to link to. Also, when there's only a hidden module to link to, don't try linking to it.
* [haddock @ 2004-03-25 10:01:42 by simonmar]simonmar2004-03-251-2/+1
| | | | Fix duplicate instance bug
* [haddock @ 2004-03-24 10:10:50 by simonmar]simonmar2004-03-241-19/+13
| | | | | | | | | | mkExportItems fix & simplification: we should be looking at the actual exported names (calculated earlier) to figure out which subordinates of a declaration are exported. This means that if you export a record, and name its fields separately in the export list, the fields will still be visible in the documentation for the constructor.
* [haddock @ 2004-03-22 14:09:03 by simonmar]simonmar2004-03-221-12/+12
| | | | | | | | getReExports was bogus: we should really look in the import_env to find the documentation for an entity which we are re-exporting without documentation. Suggested by: Ross Paterson (patch modified by me).
* [haddock @ 2003-11-12 10:03:39 by simonmar]simonmar2003-11-121-1/+1
| | | | 2002 -> 2003
* [haddock @ 2003-11-10 16:15:18 by simonmar]simonmar2003-11-101-1/+1
| | | | copyright update
* [haddock @ 2003-11-10 15:15:58 by simonmar]simonmar2003-11-101-1/+1
| | | | getReExports: one error case that isn't
* [haddock @ 2003-11-10 14:51:59 by simonmar]simonmar2003-11-101-16/+17
| | | | | Fix for getReExports: take into account names which are not visible because they are re-exported from a different package.
* [haddock @ 2003-11-10 14:41:05 by simonmar]simonmar2003-11-101-8/+29
| | | | | | | | | | | | | | | | | | | | | Re-exporting names from a different package is problematic, because we don't have access to the full documentation for the entity. Currently Haddock just ignores entities with no documentation, but this results in bogus-looking empty documentation for many of the modules in the haskell98 package. So: - the documentation will now just list the name, as a link pointing to the location of the actual documentation. - now we don't attempt to link to these re-exported entities if they are referred to by the current module. Additionally: - If there is no documentation in the current module, include just the Synopsis section (rather than just the documentation section, as it was before). This just looks nicer and was on the TODO list.
* [haddock @ 2003-11-06 16:48:11 by simonmar]simonmar2003-11-061-13/+26
| | | | | | | | | - Include the OptHide setting in the interface, so we don't include hidden modules in the combined index/contents. - Add a -k/--package flag to set the package name for the current set of modules. The package name for each module is now shown in the right-hand column of the contents, in a combined contents page.
* [haddock @ 2003-11-06 12:39:46 by simonmar]simonmar2003-11-061-8/+22
| | | | | | | | | | | | | | | | | | | | | - Add definition lists, marked up like this: -- | This is a definition list: -- -- [@foo@] The description of @foo@. -- -- [@bar@] The description of @bar@. Cunningly, the [] characters are not treated specially unless a [ is found at the beginning of a paragraph, in which case the ] becomes special in the following text. - Add --use-contents and --gen-contents, along the lines of --use-index and --gen-index added yesterday. Now we can generate a combined index and contents for the whole of the hierarchical libraries, and in theory the index/contents on the system could be updated as new packages are added.
* [haddock @ 2003-11-06 10:44:52 by simonmar]simonmar2003-11-061-4/+13
| | | | | | | Include iface_reexported in the .haddock file. This unfortunately bloats the file (40% for base). If this gets to be a problem we can always apply the dictionary trick that GHC uses for squashing .hi files.
* [haddock @ 2003-11-05 17:16:04 by simonmar]simonmar2003-11-051-4/+24
| | | | | | | | | | | | | Support for generating a single unified index for several packages. --use-index=URL turns off normal index generation, causes Index links to point to URL. --gen-index generates an combined index from the specified interfaces. Currently doesn't work exactly right, because the interfaces don't contain the iface_reexported info. I'll need to fix that up.
* [haddock @ 2003-11-05 11:30:52 by simonmar]simonmar2003-11-051-7/+15
| | | | | | | | | - Suppress warnings about unknown imported modules by default. - Add a -v/--verbose flag to re-enable these warnings. The general idea is to suppress the "Warning: unknown module: Prelude" warnings which most Haddock users will see every time, and which aren't terribly useful.
* [haddock @ 2003-11-05 11:22:04 by simonmar]simonmar2003-11-051-30/+49
| | | | | Remove the last of the uses of 'trace' to emit warnings, and tidy up a couple of places where duplicate warnings were being emitted.
* [haddock @ 2003-10-20 17:19:22 by sof]sof2003-10-201-1/+1
| | | | support for i-parameters + zip comprehensions
* [haddock @ 2003-08-27 07:50:02 by panne]panne2003-08-271-30/+28
| | | | | | | | | | | | | | | | | * Made -D a short option for --dump-interface. * Made -m a short option for --ms-help. * Made -n a short option for --no-implicit-prelude. * Made -c a short option for --css. * Removed DocBook options from executable (they didn't do anything), but mark them as reserved in the docs. Note that the short option for DocBook output is now -S (from SGML) instead of -d. The latter is now a short option for --debug. * The order of the Options in the documentation now matches the order printed by Haddock itself. Note: Although changing the names of options is often a bad idea, I'd really like to make the options for the programs in fptools more consistent and compatible to the ones used in common GNU programs.
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-02 05:59:20 +0000