Article

Haddock, a Haskell documentation tool

Author:

Simon MarlowAuthors Info & Claims

Haskell '02: Proceedings of the 2002 ACM SIGPLAN workshop on Haskell

Pages 78 - 89

https://doi.org/10.1145/581690.581697

Published: 03 October 2002 Publication History

Get Access

Abstract

This paper describes Haddock, a tool for automatically generating documentation from Haskell source code. Haddock's unique approach to source code annotations provides a useful separation between the implementation of a library and the interface (and hence also the documentation) of that library, so that as far as possible the documentation annotations in the source code do not affect the programmer's freedom over the structure of the implementation. The internal structure and implementation of Haddock is also discussed.

References

[1]

The HaskellDoc mailing list. http://www.haskell.org/mailman/listinfo/haskelldoc/.

Google Scholar

[2]

OCamldoc. http://caml.inria.fr/devtools/ocamldoc/ocamldoc.html.

Google Scholar

[3]

M. Chakravarty. IDoc - a no frills haskell interface documentation system. http://www.cse.unsw.edu.au/~chak/haskell/idoc/.

Google Scholar

[4]

I. S. Diatchki, M. P. Jones, and T. Hallgren. A formal specification of the Haskell 98 module system. In Haskell Workshop, Pittsburgh, Pennsylvania, October 2002. ACM.

Digital Library

Google Scholar

[5]

A. Groesslinger. HDoc. http://www.fmi.uni-passau.de/~groessli/hdoc/.

Google Scholar

[6]

D. E. Knuth. Literate programming. Technical Report STANCS-83-981, Department of Computer Science, Stanford University, 1983.

Google Scholar

[7]

S. Marlow. Happy, a parser-generator for haskell. http://www.haskell.org/happy/.

Google Scholar

[8]

M. Rittri. Using types as search keys in function libraries. Journal of Functional Programming, 1(1):71-89, 1991.

Crossref

Google Scholar

[9]

Sun Microsoystems. Javadoc. http://java.sun.com/j2se/javadoc/.

Google Scholar

[10]

The GHC Team. The Glasgow Haskell Compiler (GHC). http://www.haskell.org/ghc/.

Google Scholar

[11]

D. van Heesch. Doxygen. http://www.doxygen.org/.

Google Scholar

Cited By

View all

Nemeth BBrunner T(2019)HaskellCompass: Extending the CodeCompass comprehension framework for Haskell2019 IEEE 15th International Scientific Conference on Informatics10.1109/Informatics47936.2019.9119295(000149-000154)Online publication date: Nov-2019
https://doi.org/10.1109/Informatics47936.2019.9119295
Nybom KAshraf APorres I(2018)A Systematic Mapping Study on API Documentation Generation Approaches2018 44th Euromicro Conference on Software Engineering and Advanced Applications (SEAA)10.1109/SEAA.2018.00081(462-469)Online publication date: Aug-2018
https://doi.org/10.1109/SEAA.2018.00081
Flatt M(2013)Submodules in racketACM SIGPLAN Notices10.1145/2637365.251721149:3(13-22)Online publication date: 27-Oct-2013
https://dl.acm.org/doi/10.1145/2637365.2517211
Show More Cited By

Index Terms

Haddock, a Haskell documentation tool
1. Applied computing
  1. Document management and text processing
    1. Document preparation

Recommendations

Patterns of Knowledge in API Reference Documentation

Reading reference documentation is an important part of programming with application programming interfaces (APIs). Reference documentation complements the API by providing information not obvious from the API syntax. To improve the quality of reference ...
Use-Case-Specific Source-Code Documentation for Feature-Oriented Programming
VaMoS '15: Proceedings of the 9th International Workshop on Variability Modelling of Software-Intensive Systems

Source-code documentation is essential to efficiently develop and maintain large software products. Documentation is equally important for software product lines (SPLs), which represent a set of different products with a common code base. Unfortunately, ...
Building Documentation Generators
ICSM '99: Proceedings of the IEEE International Conference on Software Maintenance

In order to maintain the consistency between sources and documentation, while at the same time providing documentation at the design level, it is necessary to generate documentation from sources in such a way that it can be integrated with hand-written ...

Comments

Please enable JavaScript to view thecomments powered by Disqus.

Information & Contributors

Information

Published In

Haskell '02: Proceedings of the 2002 ACM SIGPLAN workshop on Haskell

October 2002

118 pages

ISBN:1581136056

DOI:10.1145/581690

Conference Chair:
Manuel Chakravarty
University of New South Wales, Australia

Permission to make digital or hard copies of all or part of this work for personal or classroom use is granted without fee provided that copies are not made or distributed for profit or commercial advantage and that copies bear this notice and the full citation on the first page. Copyrights for components of this work owned by others than ACM must be honored. Abstracting with credit is permitted. To copy otherwise, or republish, to post on servers or to redistribute to lists, requires prior specific permission and/or a fee. Request permissions from [email protected]

Publisher

Association for Computing Machinery

New York, NY, United States

Publication History

Published: 03 October 2002

Permissions

Request permissions for this article.

Request Permissions

Check for updates

Author Tags

Qualifiers

Article

Conference

HW02

Sponsor:

SIGPLAN

HW02: 2002 Haskell Workshop ( co-located with ICFP 2002 )

03 10 2002

Pennsylvania, Pittsburgh

Acceptance Rates

Haskell '02 Paper Acceptance Rate 9 of 24 submissions, 38%;

Overall Acceptance Rate 57 of 143 submissions, 40%

Upcoming Conference

ICFP '25

Sponsor:
sigplan

ACM SIGPLAN International Conference on Functional Programming

October 12 - 18, 2025

Singapore , Singapore

Contributors

Other Metrics

View Article Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

11
Total Citations
View Citations
451
Total Downloads

Downloads (Last 12 months)1
Downloads (Last 6 weeks)1

Reflects downloads up to 27 Dec 2024

Other Metrics

View Author Metrics

Citations

Cited By

View all

Nemeth BBrunner T(2019)HaskellCompass: Extending the CodeCompass comprehension framework for Haskell2019 IEEE 15th International Scientific Conference on Informatics10.1109/Informatics47936.2019.9119295(000149-000154)Online publication date: Nov-2019
https://doi.org/10.1109/Informatics47936.2019.9119295
Nybom KAshraf APorres I(2018)A Systematic Mapping Study on API Documentation Generation Approaches2018 44th Euromicro Conference on Software Engineering and Advanced Applications (SEAA)10.1109/SEAA.2018.00081(462-469)Online publication date: Aug-2018
https://doi.org/10.1109/SEAA.2018.00081
Flatt M(2013)Submodules in racketACM SIGPLAN Notices10.1145/2637365.251721149:3(13-22)Online publication date: 27-Oct-2013
https://dl.acm.org/doi/10.1145/2637365.2517211
Flatt MJärvi JKästner C(2013)Submodules in racketProceedings of the 12th international conference on Generative programming: concepts & experiences10.1145/2517208.2517211(13-22)Online publication date: 27-Oct-2013
https://dl.acm.org/doi/10.1145/2517208.2517211
Flatt MBarzilay EFindler R(2009)ScribbleACM SIGPLAN Notices10.1145/1631687.159656944:9(109-120)Online publication date: 31-Aug-2009
https://dl.acm.org/doi/10.1145/1631687.1596569
Flatt MBarzilay EFindler RHutton GTolmach A(2009)ScribbleProceedings of the 14th ACM SIGPLAN international conference on Functional programming10.1145/1596550.1596569(109-120)Online publication date: 31-Aug-2009
https://dl.acm.org/doi/10.1145/1596550.1596569
Frenzel L(2007)Experience reportACM SIGPLAN Notices10.1145/1291220.129118642:9(220-222)Online publication date: 1-Oct-2007
https://dl.acm.org/doi/10.1145/1291220.1291186
Frenzel LHinze RRamsey N(2007)Experience reportProceedings of the 12th ACM SIGPLAN international conference on Functional programming10.1145/1291151.1291186(220-222)Online publication date: 3-Oct-2007
https://dl.acm.org/doi/10.1145/1291151.1291186
Angelov KMarlow SLeijen D(2005)Visual haskellProceedings of the 2005 ACM SIGPLAN workshop on Haskell10.1145/1088348.1088350(5-16)Online publication date: 30-Sep-2005
https://dl.acm.org/doi/10.1145/1088348.1088350
Klint PLämmel RVerhoef C(2005)Toward an engineering discipline for grammarwareACM Transactions on Software Engineering and Methodology10.1145/1072997.107300014:3(331-380)Online publication date: 1-Jul-2005
https://dl.acm.org/doi/10.1145/1072997.1073000
Show More Cited By

View Options

Login options

Check if you have access through your login credentials or your institution to get full access on this article.

Cited By

Index Terms

Recommendations

Patterns of Knowledge in API Reference Documentation

Use-Case-Specific Source-Code Documentation for Feature-Oriented Programming

Building Documentation Generators