| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
| |
Fix for exporting record selectors from a newtype declaration
|
| |
|
|
|
| |
Fix linking to qualified names again (thanks to Sven Panne for
pointing out the bug).
|
| |
|
|
|
|
|
| |
Allow exporting of individual class methods and record selectors. For
these we have to invent the correct type signature, which we do in the
simplest possible way (i.e. no context reduction nonsense in the class
case).
|
| |
|
|
| |
Include the instances in abstract data types too
|
| |
|
|
| |
Document recent changes to markup syntax
|
| |
|
|
|
|
|
|
|
|
|
| |
Make the markup syntax a little more friendly:
- single quotes are now interpreted literally unless they surround a
valid Haskell identifier. So for example now there's no need to
escape a single quote used as an apostrophe.
- text to the right of a bird track is now literal (if you want
marked-up text in a code block, use @...@).
|
| |
|
|
| |
Back out previous change until we can find a better way to do this.
|
| |
|
|
|
|
|
|
|
| |
Handle lone occurrences of '/', e.g.,
-- | This/that.
[did this in the lexer rather than in the parser, as I couldn't
see a way not to introduce an S/R conflict that way.]
|
| |
|
|
| |
update
|
| |
|
|
|
|
|
| |
Only link to names in the current module which are actually listed in
the documentation. A name may be exported but not present in the
documentation if it is exported as part of a 'module M' export
specifier.
|
| |
|
|
| |
If an identifier doesn't lex, then just replace it by a DocString.
|
| |
|
|
| |
Add some more test cases
|
| |
|
|
| |
Rename the module documentation properly (bug reported by Sven Panne).
|
| |
|
|
|
| |
Do something sensible for modules which don't export anything (except
instances).
|
| |
|
|
| |
hyperlinked identifiers should be in <tt>
|
| |
|
|
| |
warning message tweak
|
| |
|
|
| |
Fix some bugs in the rendering of qualified type signatures.
|
| |
|
|
| |
Fix bug: we weren't renaming HsDocCommentNamed in renameDecl
|
| |
|
|
|
|
|
|
|
| |
- Put function arguments *before* the doc for the function, as suggested
by Sven Panne. This looks nicer when the function documentation is
long.
- Switch to using bold for binders at the definition site, and use
underline for keywords. This makes the binder stand out more.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
Lots of changes:
- instances of a class are listed with the class, and
instances involving a datatype are listed with that type.
Derived instances aren't included at the moment: the calculation
to find the instance head for a derived instance is non-trivial.
- some formatting changes; use rows with specified height rather than
cellspacing in some places.
- various fixes (source file links were wrong, amongst others)
|
| |
|
|
| |
Rearrange a bit, and add support for tabular datatype rendering
|
| |
|
|
| |
add a few more test cases
|
| |
|
|
|
| |
- Use an alternate tabular layout for datatypes, which is more compact
- Fix some problems with the function argument documentation
|
| |
|
|
| |
Fix bugs in qualified name handling (A.B.f was returned as B.f)
|
| |
|
|
| |
Patch to add support for GHC-style primitive strings ".."#, from Ross Paterson.
|
| |
|
|
|
|
|
| |
- Remove the note about function argument docs not being implemented
- Note that qualified identifiers can be used to point to entities
that aren't in scope.
|
| |
|
|
| |
Rename Foo.hs to Test.hs, and add a Makefile
|
| |
|
|
| |
update
|
| |
|
|
| |
Bump to version 0.3
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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.
|
| |
|
|
| |
Preserve the newline before a bird-track, but only within a paragraph.
|
| |
|
|
| |
Fix one of the record examples
|
| |
|
|
|
|
|
| |
Cope with datatypes which have documentation on the constructor but
not the type itself, and records which have documentation on the
fields but not the constructor. (Thanks to Ross Paterson for pointing
out the bugs).
|
| |
|
|
| |
a couple more things, prioritise a bit
|
| |
|
|
|
|
|
| |
Allow backquote as the right-hand quote as well as the left-hand
quote, as suggested by Dean Herrington.
Clean up the grammar a litte.
|
| |
|
|
| |
fix typos
|
| |
|
|
| |
Only include a mini-contents if there are 2 or more sections
|
| |
|
|
| |
oops, update to version 0.2
|
| |
|
|
| |
Document changes since 0.1
|
| |
|
|
| |
update
|
| |
|
|
| |
mention the backquote-style of markup
|
| |
|
|
| |
Add the changelog/release notes
|
| |
|
|
| |
Add dependency
|
| |
|
|
| |
Print the module name in a doc-string parse error
|
| |
|
|
| |
Test existential types, amongst other things
|
| |
|
|
| |
Add System Requirements section
|
| |
|
|
| |
Add 'stdcall' keyword
|
| |
|
|
| |
Type synonyms can accept a ctype on the RHS, to match GHC.
|
| |
|
|
| |
Add a special case for list types in ppHsAType
|
| |
|
|
|
| |
Don't consider a module re-export as having documentation, for the
purposes of deciding whether we need a Synopsis section or not.
|
