aboutsummaryrefslogtreecommitdiff
path: root/src/Haddock/Types.hs
Commit message (Collapse)AuthorAgeFilesLines
* Move sources under haddock-api/srcMateusz Kowalczyk2014-08-231-552/+0
|
* Revert "Track GHC PackageId to PackageKey renaming."Mateusz Kowalczyk2014-08-141-1/+1
| | | | This reverts commit 8ac42d3327473939c013551750425cac191ff0fd.
* Track GHC PackageId to PackageKey renaming.Edward Z. Yang2014-07-211-1/+1
| | | | | | | Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu> Conflicts: src/Haddock/Interface/Create.hs
* Move parser + parser tests out to own package.Mateusz Kowalczyk2014-05-051-56/+2
| | | | | | | | | | We move some types out that are necessary as well and then re-export and specialise them in the core Haddock. Reason for moving out spec tests is that if we're working on the parser, we can simply work on that and we can ignore the rest of Haddock. The downside is that it's a little inconvenient if at the end of the day we want to see that everything passes.
* Prepare modules for parser split.Mateusz Kowalczyk2014-05-051-14/+16
| | | | | We have to generalise the Doc (now DocH) slightly to remove the dependency on GHC-supplied type.
* Hide RHS of TFs with non-exported right hand sidesNiklas Haas2014-03-131-3/+3
| | | | | | Not sure what to do about data families yet, since technically it would not make a lot of sense to display constructors that cannot be used by the user.
* Include fixity information in the Interface fileNiklas Haas2014-03-111-0/+3
| | | | | | This resolves fixity information not appearing across package borders. The binary file version has been increased accordingly.
* Differentiate between TH splices (line-links) and regular namesNiklas Haas2014-03-091-0/+4
| | | | | | | | | | | | | | | | | This adds a new type of source code link, to a specific line rather than a specific declaration/name - this is used to link to the location of a TH splice that defines a certain name. Rather hefty changes throughout and still one unresolved issue (the line URLs aren't parsed from the third form of --read-interface which means they're currently restricted to same-interface links). Not sure if this issue is really worth all the hassle, especially since we could just use line links in general. This commit also contains some cleanup/clarification of the types in Haddock.Backends.Xhtml.Decl and shortens some overlong lines in the process. Notably, the Bool parameter was replaced by a Unicode type synonym to help clarify its presence in type signatures.
* Render fixity informationNiklas Haas2014-03-081-0/+6
| | | | | | Affects functions, type synonyms, type families, class names, data type names, constructors, data families, associated TFs/DFs, type synonyms, pattern synonyms and everything else I could think of.
* Improve display of poly-kinded type operatorsnand2014-02-111-3/+3
| | | | | | | This now displays them as (==) k a b c ... to mirror GHC's behavior, instead of the old (k == a) b c ... which was just wrong. Signed-off-by: Mateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>
* Add support for type/data familiesnand2014-02-111-5/+17
| | | | | | | | This adds support for type/data families with their respective instances, as well as closed type families and associated type/data families. Signed-off-by: Mateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>
* Allow for nesting of paragraphs under lists.Mateusz Kowalczyk2014-01-121-1/+1
| | | | | | | | | | | | | | | | | The nesting rules are similar to Markdown's with the exception that we can not simply indent the first line of a hard wrapped indented paragraph and have it treated as if it was fully indented. The reason is differences in markup as some of our constructs care about whitespace while others just swallow everything up so it's just a lot easier to not bother with it rather than making arbitrary rules. Note that we now drop trailing for string entities inside of lists. They weren't needed and it makes the output look uniform whether we use a single or double newline between list elements. Conflicts: src/Haddock/Parser.hs test/Haddock/ParserSpec.hs
* Per-module extension flags and language listing.Mateusz Kowalczyk2014-01-121-2/+9
| | | | | | | | | | | | | Any extensions that are not enabled by a used language (Haskell2010 &c) will be shown. Furthermore, any implicitly enabled are also going to be shown. While we could eliminate this either by using the GHC API or a dirty hack, I opted not to: if a user doesn't want the implied flags to show, they are recommended to use enable extensions more carefully or individually. Perhaps this will encourage users to not enable the most powerful flags needlessly. Enabled with show-extensions. Conflicts: src/Haddock/InterfaceFile.hs
* Allow for headings inside function documentation.Mateusz Kowalczyk2014-01-121-0/+16
| | | | | | | | | | | | | LaTeX will treat the h3-h6 headings the same as we'd have to hack the style file heavily otherwise and it would make the headings tiny anyway. Hoogle upstream said they will put in the functionality on their end. Conflicts: src/Haddock/Interface/Rename.hs src/Haddock/Types.hs test/Haddock/ParserSpec.hs
* Support for bold.Mateusz Kowalczyk2014-01-121-1/+4
| | | | | | | Conflicts: src/Haddock/Backends/Hoogle.hs src/Haddock/Interface/Rename.hs src/Haddock/Parser.hs
* One pass parser and tests.Mateusz Kowalczyk2014-01-121-20/+13
| | | | | | | | We remove the HTML test as it is no longer necessary. We cover the test case in spec tests and other HTML tests but keeping this around fails: this is because the new parser has different semantics there. In fact, I suspect the original behaviour was a bug that wasn't caught/fixed but simply included as-is during the testing.
* Some code simplification by using traverseSimon Hengel2014-01-121-2/+4
|
* Fix AMP warningsDavid Luposchainsky2013-09-081-0/+8
| | | | Signed-off-by: Austin Seipp <aseipp@pobox.com>
* Output Copright and License keys in Xhtml backend.Mathieu Boespflug2013-08-041-7/+11
| | | | | | | This information is as relevant in the documentation as it is in the source files themselves. Signed-off-by: David Waern <david.waern@gmail.com>
* Properly handle deprecation messages for re-exported things (fixes #220)Simon Hengel2012-10-141-0/+5
|
* Allow haddock markup in deprecation messagesSimon Hengel2012-10-141-1/+38
|
* Add markup support for propertiesKazu Yamamoto2012-10-091-0/+2
|
* Improve haddock memory usageIan Lynagh2012-08-131-29/+29
|
* Merge branch 'dev' of https://github.com/sol/haddock into ghc-7.6David Waern2012-07-231-2/+8
|\ | | | | | | | | Conflicts: src/Haddock/InterfaceFile.hs
| * Add support for hyperlink labels to parserSimon Hengel2012-05-271-1/+1
| |
| * Add an optional label to URLsSimon Hengel2012-05-271-2/+8
| |
* | Forward port changes from stable.Paolo Capriotti2012-07-191-18/+61
|\|
| * Attach warnings to `Documentation` typeSimon Hengel2012-05-171-3/+10
| |
| * newtype-wrap Doc nodes for things that may have warnings attachedSimon Hengel2012-05-171-10/+10
| |
| * qualification style 'abbreviated' -> 'aliased'Henning Thielemann2012-04-021-8/+8
| |
| * abbreviated qualification: use Packages.lookupModuleInAllPackages for ↵Henning Thielemann2012-04-021-1/+1
| | | | | | | | finding the package that a module belongs to
| * 'abbreviate' qualification style - basic supportHenning Thielemann2012-04-011-13/+26
| | | | | | | | | | Currently we ignore the package a module is imported from. This means that a module import would shadow another one with the same module name from a different package.
| * add QualOption type for distinction between qualification argument given by ↵Henning Thielemann2012-04-011-5/+27
| | | | | | | | | | the user and the actual qualification for a concrete module
| * Mostly hlint-inspired cleanup.David Waern2012-02-041-1/+1
| |
| * Clean up some code from last SoC project.David Waern2012-02-041-1/+0
| |
| * Add DocWarning to DocSimon Hengel2012-02-041-0/+2
| | | | | | | | | | The Xhtml backend has special markup for that, Hoogle and LaTeX reuse what we have for DocEmphasis.
* | Follow rename of Instance to ClsInst in GHCIan Lynagh2012-01-031-1/+1
|/
* Minor fixes and cleanup.David Waern2011-12-281-3/+2
|
* Go back to having a doc, sub and decl map instead of one big decl map.David Waern2011-12-271-14/+18
| | | | | | | | | This setup makes more sense since when we add value bindings to the processed declarations (for type inference), we will have multiple declarations which should share documentation. Also, we already have a separate doc map for instances which we can now merge into the main doc map. Another benefit is that we don't need the DeclInfo type any longer.
* Slightly better behaviour on top-levels without type signatures.David Waern2011-12-031-1/+7
| | | | | | | | - Docs don't get attached to the next top-level with signature by mistake. - If there's an export list and the top-level is part of it, its doc comment shows up in the documentation.
* Allow doc comments to link to out-of-scope things (#78).David Waern2011-11-261-18/+20
| | | | (A bug that should have been fixed long ago.)
* Give preference to type over data constructors for doc comment links at ↵David Waern2011-11-261-2/+3
| | | | | | | | | | | renaming time. Previously this was done in the backends. Also, warn when a doc comment refers to something that is in scope but which we don't have the .haddock file for. These changes mean we can make DocIdentifier [a] into DocIdentifier a.
* Add safe haskell indication to haddock outputDavid Terei2011-10-121-0/+2
|
* Adapt Haddock for the ConstraintKind extension changesMax Bolingbroke2011-09-061-1/+1
|
* Fix buildIan Lynagh2011-06-171-1/+0
|
* Follow the style guide closer in Haddock.Types and improve docsDavid Waern2010-11-201-143/+147
|
* Haddock documentation updatesDavid Waern2010-11-201-8/+14
|
* Remove docNameOcc under the motto "don't name compositions"David Waern2010-11-151-5/+0
|
* Style policeDavid Waern2010-10-161-13/+14
|
* Use "qual" as an abbreviation for qualification instead of "quali" for ↵David Waern2010-10-161-5/+5
| | | | consistency
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-13 08:37:38 +0000