Simon Marlow wrote:
Alfonso Acosta wrote:
I'm beginning to get familiar with Haddock and I want to document a library which, as usually happens, has some ADT definitions.
I'd like to document the ADTs both for the end-user (who shouldn't be told about its internal implementation) and future developers.
Haddock is designed to document APIs for the end-user rather than the developer, although it has been suggested several times that it could generate source-code documentation too.
maybe first the paragraph for the end-user, followed by CURRENT IMPLEMENTATION DETAILS/NOTES: After all, those are sometimes relevant or interesting to the "end-user" (or are the implementation descriptions consistently several times longer than the API documentation, too distractingly?) Isaac