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

Add documentation to gradle popup description of tasks in build.gradle.kts file? #1345

Closed
cschar opened this issue Mar 14, 2023 · 1 comment

Comments

@cschar
Copy link

cschar commented Mar 14, 2023

Is your feature request related to a problem? Please describe.
I find it hard to keep track of what all the options do inside this plugin,
when staring at my IDE trying to figure out what the task does, I put my mouse over it hoping for some insight:
https://imgur.com/a/Cv65KK1
Nothing comes up, but I was hoping to have a similar description of what is found on the websites documentation:

https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#tasks-buildsearchableoptions

Builds an index of UI components (searchable options) for the plugin. This task runs a headless IDE instance to collect all the available options provided by the plugin's [Settings](https://plugins.jetbrains.com/docs/intellij/settings.html).

Note, that this is a [runIde](https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#tasks-runide)-based task with predefined arguments and all properties of the [runIde](https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#tasks-runide) task are also applied to [buildSearchableOptions](https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#tasks-buildsearchableoptions) tasks.

Describe the solution you'd like
Would it be possible to have the task description have a description similar to what is on the website documentation

Describe alternatives you've considered
even description with link to direct anchor in website would be helpful.
e.x.: "https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#tasks-buildsearchableoptions"

Additional context
Add any other context or screenshots about the feature request here.

@hsz hsz self-assigned this Mar 14, 2023
@hsz hsz added this to the next milestone Mar 14, 2023
@hsz
Copy link
Member

hsz commented Mar 23, 2023

@cschar Thanks for filing this issue. I have investigated this case, and there's currently no solution we could implement.
This is because the buildSearchableOptions task, and any other provided by Gradle plugins, that are available within the tasks {} closure, are automatically generated by Gradle when applied to the project.

The buildSearchableOptions is actually a helper which looks like:

public val org.gradle.api.tasks.TaskContainer.buildSearchableOptions: org.gradle.api.tasks.TaskProvider<org.jetbrains.intellij.tasks.BuildSearchableOptionsTask> /* compiled code */

Therefore, it doesn't provide any documentation when i.e. pressing the F1 key in the IDE.
image

Note that the F1 key provides a more detailed definition than hovering an item.

Given that, you can still click on the BuildSearchableOptionsTask class name to get more details:
image

As you see, the description is presented — but this is currently a mock created for the screenshot. ;-)

I'm going to extend current tasks and extension with proper top-level documentation so it becomes available with the next update.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants