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.

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

Custom block types #487

Closed
JanMalch opened this issue Jul 10, 2019 · 4 comments
Closed

Custom block types #487

JanMalch opened this issue Jul 10, 2019 · 4 comments
Labels
enhancement An issue for a feature or an overall improvement

Comments

@JanMalch
Copy link

Is it possible to have custom output for custom block tags? How would you do this with dokka?

For example via plugins and hooking into existing generators.

@kamildoleglo
Copy link
Contributor

Hi @JanMalch, could you elaborate on that (preferably show an example)?

@kamildoleglo kamildoleglo added awaiting response An issue/PR that cannot be completed without additional information or a discussion question A user question, can be resolved if the question is answered/resolved labels Oct 2, 2019
@JanMalch
Copy link
Author

JanMalch commented Oct 2, 2019

I would like to define my own block tags like the @say in the following code:

/**
 * Does something.
 * @say Hello World
 */
fun foo() {}

So I can later write a plugin / generator which reads this custom tag and has custom output.

Starting MyCustomDokkaGenerator ...
Function 'foo' says 'Hello World'

Hope that helps.

@kamildoleglo
Copy link
Contributor

kamildoleglo commented Oct 2, 2019

Yup, I get it now. This or something similar is planned for the next release (0.10.1), if I'm not mistaken.

@kamildoleglo kamildoleglo added enhancement An issue for a feature or an overall improvement and removed awaiting response An issue/PR that cannot be completed without additional information or a discussion question A user question, can be resolved if the question is answered/resolved labels Oct 2, 2019
@Kordyjan
Copy link
Contributor

Kordyjan commented Sep 2, 2020

Plugin api is ready to be used, so I consider this issue to be closed.
More info about plugins: https://github.com/Kotlin/dokka/blob/master/plugins/developer_guide.md

@Kordyjan Kordyjan closed this as completed Sep 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An issue for a feature or an overall improvement
Projects
None yet
Development

No branches or pull requests

3 participants