| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
| |
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.
|
| |
|
|
| |
another item done
|
| |
|
|
|
|
|
|
|
|
| |
The last commit to Main.lhs broke the delicate balance of laziness
which was being used to avoid computing the dependency graph of
modules.
So I finally bit the bullet and did a proper topological sort of the
module graph, which turned out to be easy (stealing the Digraph module
from GHC - this really ought to be in the libraries somewhere).
|
| |
|
|
| |
Give a more useful instance of Show for Module.
|
| |
|
|
| |
Fix buglet
|
| |
|
|
| |
oops, left out '/' from the special characters in the last change.
|
| |
|
|
| |
typo
|
| |
|
|
| |
Update to version 0.2
|
| |
|
|
| |
update
|
| |
|
|
| |
Add support for existential quantifiers on constructors.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
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.
|
| |
|
|
|
|
|
|
|
|
| |
Change the markup for typewriter-font from [...] to @...@. The
reasoning is that the '@' symbol is much less likely to be needed than
square brackets, and we don't want to have to escape square brackets
in code fragments.
This will be mildly painful in the short term, but it's better to get
the change out of the way as early as possible.
|
| |
|
|
| |
Update to test new features.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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.
|
| |
|
|
| |
Allow code blocks to be denoted with bird-tracks in addition to [...].
|
| |
|
|
|
| |
DocEmpty is a right and left-unit of DocAppend (remove it in the smart
constructor).
|
| |
|
|
| |
Be more lenient about extra paragraph breaks
|
| |
|
|
| |
Add another named chunk with a different name
|
| |
|
|
| |
Fix silly bug in named documentation block lookup.
|
| |
|
|
| |
Allow empty data declarations (another GHC extension).
|
| |
|
|
| |
Remove workaround for simplifier bug in previous revision.
|
| |
|
|
|
| |
Add missing type signature (a different workaround for the bug in
GHC's simplifier).
|
| |
|
|
| |
Add RPM spec file (thanks to Tom Moertel <tom-rpms@moertel.com>)
|
| |
|
|
|
|
| |
As a temporary hack/workaround for a bug in GHC's simplifier, don't
pass Happy the -c option for generating the parsers in this
subdir. Furthermore, disable -O for HaddocParse, too.
|
| |
|
|
| |
Fix some typos.
|
| |
|
|
| |
Add another item
|
| |
|
|
| |
update
|
| |
|
|
| |
Add BinDist bits
|
| |
|
|
| |
Install the auxilliary bits
|
