Simon Marlow
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.
- The HaskellDoc mailing list. http://www.haskell.org/mailman/listinfo/haskelldoc/.Google Scholar
- OCamldoc. http://caml.inria.fr/devtools/ocamldoc/ocamldoc.html.Google Scholar
- M. Chakravarty. IDoc - a no frills haskell interface documentation system. http://www.cse.unsw.edu.au/~chak/haskell/idoc/.Google Scholar
- 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. Google ScholarDigital Library
- A. Groesslinger. HDoc. http://www.fmi.uni-passau.de/~groessli/hdoc/.Google Scholar
- D. E. Knuth. Literate programming. Technical Report STANCS-83-981, Department of Computer Science, Stanford University, 1983.Google Scholar
- S. Marlow. Happy, a parser-generator for haskell. http://www.haskell.org/happy/.Google Scholar
- M. Rittri. Using types as search keys in function libraries. Journal of Functional Programming, 1(1):71-89, 1991.Google ScholarCross Ref
- Sun Microsoystems. Javadoc. http://java.sun.com/j2se/javadoc/.Google Scholar
- The GHC Team. The Glasgow Haskell Compiler (GHC). http://www.haskell.org/ghc/.Google Scholar
- D. van Heesch. Doxygen. http://www.doxygen.org/.Google Scholar
Index Terms
- Haddock, a Haskell documentation tool
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 SystemsSource-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 MaintenanceIn 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