Skip to content
This repository was archived by the owner on Aug 3, 2024. It is now read-only.
This repository was archived by the owner on Aug 3, 2024. It is now read-only.

Excluding some exported functions from the documentation #529

@andreasabel

Description

@andreasabel

Is there a way to exclude some functions from the haddockumentation even if they are exported from a module?

I am confronted with the following scenario:

  1. I want to verify (quickcheck) a library outside of this library.
  2. This involves writing testable properties of internal (non-exported) functions.
  3. As the Haskell module system prevents this, I have to export the internal functions as well.
  4. I do not want them to show up in the library haddockumentation.

Any way to achieve this?

Ideally, the documentation generation should be possible independent of the constraints of the Haskell module system.

According to https://www.haskell.org/haddock/doc/html/introduction.html, Haddock supports reexporting documentation from an internal module to a user-exposed module, but for my purposes I would need this on the library level.

Quoting https://www.haskell.org/haddock/doc/html/introduction.html:

Haddock therefore understands the Haskell module system and can generate documentation which hides not only non-exported entities from the interface, but also the internal module structure of the interface. A documentation annotation can still be placed next to the implementation, and it will be propagated to the external module in the generated documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions