Skip to content

Allow hiding the documentation for types by adding @private to the docblock #88

@adrianschmidt

Description

@adrianschmidt

Originally posted by @adrianschmidt in Lundalogik/lime-elements#1793 (comment)


Hmm… types that are documented are probably shown regardless of whether the component we think they "belong to" is marked as private or not. But I guess there's a docblock for the type too, have you tried adding @Private to that? If that doesn't work, that seems like a good fit for feature request in Kompendium.

Added and pushed. Let's see what happens online here lundalogik.github.io/lime-elements/versions/PR-1792/#/type/DockItem

I think we should open a feature request in Kompendium for this. I'm summarising the problem a little here to have a concise comment to reference in the issue in Kompendium 😊

The @private tag is set on the interface:

Screenshot showing that the `@private` tag has indeed been set in the docblock for the `DockItem` interface

The docs have been published:

Screenshot showing that the latest run of the 'Publish Docs' action completed successfully

The interface is still visible in the docs:

Screenshot showing that the documentation for the `DockItem` interface is still visible in the documentation menu's 'Types' section

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions