Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

No support for @hide annotation #751

Closed
simoarpe opened this issue Mar 18, 2020 · 2 comments · Fixed by #1742
Closed

No support for @hide annotation #751

simoarpe opened this issue Mar 18, 2020 · 2 comments · Fixed by #1742
Labels
enhancement An issue for a feature or an overall improvement
Milestone
0.11.0

Comments

@simoarpe
Copy link

simoarpe commented Mar 18, 2020 •
edited
Loading

Currently, Dokka offers no support for @hide annotations
They are quite common when dealing with large Android codebase.
The behavior is very simple: when an API is marked as hidden it will not land in the generated API documentation.

I'm not sure if I can achieve this behavior by using a custom Dokka runtime.
I've invested some time looking at some examples like Dokka Hugo Extension and spring-auto-restdocs but they seem to focus on something different.

Any suggestions how to tackle this?
@simoarpe simoarpe added the enhancement An issue for a feature or an overall improvement label Mar 18, 2020
@kamildoleglo
Copy link
Contributor

kamildoleglo commented May 13, 2020 •
edited
Loading

It will be possible to create a plugin that does this when 0.11.0 is released. Right now you can use @suppress if I'm not mistaken to achieve the same effect

@kamildoleglo kamildoleglo added this to the 0.11.0 milestone May 13, 2020
@MariusVolkhart
Copy link

FYI, using @suppress is broken in 1.4.x version of Dokka. See #1612

@MarcinAman MarcinAman linked a pull request Feb 11, 2021 that will close this issue
Suppress tag support #1742
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement An issue for a feature or an overall improvement
Projects
None yet
Milestone
0.11.0
Development

Successfully merging a pull request may close this issue.

Suppress tag support Kotlin/dokka
3 participants
@MariusVolkhart @simoarpe @kamildoleglo