doccheck: Checks Haddock comments for pitfalls and version changes.

[ documentation, gpl, program ] [ Propose Tags ]

This tool aims to detect any common pitfalls that is often seen in documentation generated with Haddock, commonly caused by lack of familiarity with the markup or time to review the generated documentation. Extending this tool is rather simple (add parsers) and can be easily used to judge the impact of changing Haddock's parsing rules.


[Skip to Readme]
Versions 0.1.0.0
Dependencies attoparsec (>=0.10), base (>=4.6 && <5), directory, directory-tree (>=0.11), filepath, ghc (>=7.6), ghc-paths (>=0.1), text (>=0.11) [details]
License GPL-3.0-only
Copyright (c) Mateusz Kowalczyk
Author Mateusz Kowalczyk
Maintainer Mateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>
Category Documentation
Home page https://github.com/Fuuzetsu/doccheck
Bug tracker https://github.com/Fuuzetsu/doccheck/issues
Source repo head: git clone git@github.com:Fuuzetsu/doccheck.git
Uploaded by MateuszKowalczyk at Tue Aug 13 15:03:57 UTC 2013
Distributions NixOS:0.1.0.0
Executables doccheck
Downloads 582 total (13 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
Successful builds reported [all 8 reports]
Hackage Matrix CI

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for doccheck-0.1.0.0

[back to package description]

doccheck

A very naive tool to identify any potentially doc-breaking/changing structures in Haddock documentation.

Usage: doccheck [-h] [file ...]