aboutsummaryrefslogtreecommitdiff
path: root/src/HsLexer.lhs
Commit message (Collapse)AuthorAgeFilesLines
* Initial modifications -- doesn't compiledavve2006-07-101-1/+1
|
* replace a fatal error in lexChar with a parseErrorSimon Marlow2006-05-241-2/+4
|
* Extend URL variable expansion syntax and add source links to the contents pageDuncan Coutts2006-01-221-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | 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-89/+120
| | | | | | | | | | | | | | | | | | | | | 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
* [haddock @ 2005-03-09 08:28:39 by wolfgang]wolfgang2005-03-091-1/+6
| | | | | Hack haddock's lexer to accept the output from Apple's broken version of cpp (Apple's cpp leaves #pragma set_debug_pwd directives in it's output).
* [haddock @ 2005-01-04 16:15:51 by simonmar]simonmar2005-01-041-3/+16
| | | | parser fix: allow qualified specialids.
* [haddock @ 2004-05-09 14:39:53 by panne]panne2004-05-091-2/+2
| | | | | | Fix the fix for single-line comment syntax, ------------------------------------------- is now a valid comment line again.
* [haddock @ 2004-04-14 10:03:25 by simonmar]simonmar2004-04-141-2/+2
| | | | fix for single-line comment syntax
* [haddock @ 2003-10-20 17:19:22 by sof]sof2003-10-201-3/+9
| | | | support for i-parameters + zip comprehensions
* [haddock @ 2003-08-18 10:04:47 by simonmar]simonmar2003-08-181-1/+2
| | | | Lex the 'mdo' keyword as 'do'.
* [haddock @ 2002-07-24 09:42:17 by simonmar]simonmar2002-07-241-82/+112
| | | | Patches to quieten ghc -Wall, from those nice folks at Galois.
* [haddock @ 2002-05-17 10:51:57 by simonmar]simonmar2002-05-171-10/+9
| | | | Fix bugs in qualified name handling (A.B.f was returned as B.f)
* [haddock @ 2002-05-15 13:28:46 by simonmar]simonmar2002-05-151-1/+2
| | | | Patch to add support for GHC-style primitive strings ".."#, from Ross Paterson.
* [haddock @ 2002-05-15 13:03:01 by simonmar]simonmar2002-05-151-20/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Reworking of the internals to support documenting function arguments (the Most Wanted new feature by the punters). The old method of keeping parsed documentation in a Name -> Doc mapping wasn't going to cut it for anntations on type components, where there's no name to attach the documentation to, so I've moved to storing all the documentation in the abstract syntax. Previously some of the documentation was left in the abstract syntax by the parser, but was later extracted into the mapping. In order to avoid having to parameterise the abstract syntax over the type of documentation stored in it, we have to parse the documentation at the same time as we parse the Haskell source (well, I suppose we could store 'Either String Doc' in the HsSyn, but that's clunky). One upshot is that documentation is now parsed eagerly, and documentation parse errors are fatal (but have better line numbers in the error message). The new story simplifies matters for the code that processes the source modules, because we don't have to maintain the extra Name->Doc mapping, and it should improve efficiency a little too. New features: - Function arguments and return values can now have doc annotations. - If you refer to a qualified name in a doc string, eg. 'IO.putStr', then Haddock will emit a hyperlink even if the identifier is not in scope, so you don't have to make sure everything referred to from the documentation is imported. - several bugs & minor infelicities fixed.
* [haddock @ 2002-05-09 12:45:19 by simonmar]simonmar2002-05-091-2/+3
| | | | Add 'stdcall' keyword
* [haddock @ 2002-05-09 10:34:44 by simonmar]simonmar2002-05-091-2/+2
| | | | Fix buglet
* [haddock @ 2002-05-08 13:39:56 by simonmar]simonmar2002-05-081-27/+56
| | | | | | | | | | | | | | Allow nested-style comments to be used as documentation annotations too. eg. {-| ... -} is equivalent to -- | ... An extra space can also be left after the comment opener: {- | ... -}. The only version that isn't allowed is {-# ... -}, because this syntax overlaps with Haskell pragmas; use {- # ... -} instead.
* [haddock @ 2002-05-08 11:21:56 by simonmar]simonmar2002-05-081-1/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add a facility for specifying options that affect Haddock's treatment of the module. Options are given at the top of the module in a comma-separated list, beginning with '-- #'. eg. -- # prune, hide, ignore-exports Options currently available, with their meanings: prune: ignore declarations which have no documentation annotations ignore-exports: act as if the export list were not specified (i.e. export everything local to the module). hide: do not include this module in the generated documentation, but propagate any exported definitions to modules which re-export them. There's a slight change in the semantics for re-exporting a full module by giving 'module M' in the export list: if module M does not have the 'hide' option, then the documentation will now just contain a reference to module M rather than the full inlined contents of that module. These features, and some other changes in the pipeline, are the result of discussions between myself and Manuel Chakravarty <chak@cse.unsw.edu.au> (author of IDoc) yesterday. Also: some cleanups, use a Writer monad to collect error messages in some places instead of just printing them with trace.
* [haddock @ 2002-04-25 14:40:05 by simonmar]simonmar2002-04-251-2/+4
| | | | | | | - Add support for named chunks of documentation which can be referenced from the export list. - Copy the icon from $libdir to the destination in HTML mode.
* [haddock @ 2002-04-24 15:12:41 by simonmar]simonmar2002-04-241-3/+7
| | | | | Stop slurping comment lines when we see a row of dashes longer than length 2: these are useful as separators.
* [haddock @ 2002-04-09 11:23:24 by simonmar]simonmar2002-04-091-1/+3
| | | | Add '-- /' as a synonym for '-- |', for compatibility with IDoc.
* [haddock @ 2002-04-04 16:23:43 by simonmar]simonmar2002-04-041-0/+577
This is Haddock, my stab at a Haskell documentation tool. It's not quite ready for release yet, but I'm putting it in the repository so others can take a look. It uses a locally modified version of the hssource parser, extended with support for GHC extensions and documentation annotations.