Skip to content
This repository has been archived by the owner on Aug 19, 2020. It is now read-only.

Consider automatically extracting javadoc from the Gradle API and converting it to KDoc #120

Closed
bamboo opened this issue Sep 6, 2016 · 5 comments

Comments

@bamboo
Copy link
Member

bamboo commented Sep 6, 2016

JavaParser might be a good option.

@yole
Copy link
Contributor

yole commented Sep 6, 2016

Why exactly do you need that? Dokka can parse Javadoc in Java code and generate Kotlin documentation from it.

@bamboo
Copy link
Member Author

bamboo commented Sep 6, 2016

@yole gradle-script-kotlin currently generates extension members for the Gradle API so Action<T> parameters are treated as T.() -> Unit (see #117). We want those extensions to sort of inherit the documentation of the members they were generated from so the docs are immediately accessible in the IDE without any indirections.

Could Dokka be used to programatically extract KDoc from the Gradle Java source files?

@yole
Copy link
Contributor

yole commented Sep 7, 2016

If you need to see docs in the IDE, it's possible to write a custom extension in the plugin that would show them. This should be far easier than building a separate tool to extract and convert the docs.

@bamboo
Copy link
Member Author

bamboo commented Sep 7, 2016

@yole, far easier sounds great! If I understood you correctly this would be like writing a plugin to the IDEA Kotlin plugin? Could you share any pointers on that?

@bamboo bamboo modified the milestones: 0.4.0, 0.5.0 Sep 8, 2016
@bamboo
Copy link
Member Author

bamboo commented Oct 18, 2016

Superseded by #155. Extension members will not be needed.

@bamboo bamboo closed this as completed Oct 18, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants